<!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>[13986] twext/trunk/twext/who/xml.py</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/13986">13986</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2014-09-20 07:17:45 -0700 (Sat, 20 Sep 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Preserve any text prior to the root element when writing. Use fixed element order when writing.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoxmlpy">twext/trunk/twext/who/xml.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhoxmlpy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/xml.py (13985 => 13986)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/xml.py        2014-09-20 14:14:26 UTC (rev 13985)
+++ twext/trunk/twext/who/xml.py        2014-09-20 14:17:45 UTC (rev 13986)
</span><span class="lines">@@ -50,6 +50,7 @@
</span><span class="cx"> )
</span><span class="cx"> from .util import ConstantsContainer
</span><span class="cx"> 
</span><ins>+import itertools
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> ##
</span><span class="lines">@@ -148,7 +149,18 @@
</span><span class="cx">     attribute = Attribute
</span><span class="cx">     recordTypeValue = RecordTypeValue
</span><span class="cx"> 
</span><ins>+    xmlFieldOrder = (
+        BaseFieldName.recordType,
+        BaseFieldName.uid,
+        BaseFieldName.guid,
+        BaseFieldName.shortNames,
+        BaseFieldName.fullNames,
+        BaseFieldName.emailAddresses,
+        BaseFieldName.password,
+        IndexFieldName.memberUIDs,
+    )
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx">     def __init__(self, filePath, refreshInterval=4):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         @param filePath: A file path for the XML data to load into the
</span><span class="lines">@@ -162,6 +174,7 @@
</span><span class="cx">         BaseDirectoryService.__init__(self, realmName=noRealmName)
</span><span class="cx"> 
</span><span class="cx">         self.filePath = filePath
</span><ins>+        self.filePreamble = &quot;&quot;
</ins><span class="cx">         self.refreshInterval = refreshInterval
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -252,6 +265,10 @@
</span><span class="cx">         #
</span><span class="cx">         try:
</span><span class="cx">             with self.filePath.open() as fh:
</span><ins>+                lines = fh.read().splitlines()
+                self.filePreamble = &quot;\n&quot;.join(itertools.takewhile(lambda x: not x.startswith(&quot;&lt;directory&quot;), lines))
+
+            with self.filePath.open() as fh:
</ins><span class="cx">                 try:
</span><span class="cx">                     etree = parseXML(fh)
</span><span class="cx">                 except XMLParseError as e:
</span><span class="lines">@@ -472,7 +489,12 @@
</span><span class="cx"> 
</span><span class="cx">         def fillRecordNode(recordNode, record):
</span><span class="cx">             subNode = None
</span><del>-            for (name, value) in record.fields.items():
</del><ins>+            fields = list(self.xmlFieldOrder)
+            fields.extend(filter(lambda k: k not in self.xmlFieldOrder, record.fields))
+            for name in fields:
+                if name not in record.fields:
+                    continue
+                value = record.fields[name]
</ins><span class="cx">                 if name == self.fieldName.recordType:
</span><span class="cx">                     if value in recordTypes:
</span><span class="cx">                         recordNode.set(
</span><span class="lines">@@ -561,7 +583,7 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def _writeDirectoryNode(self, directoryNode):
</span><del>-        self.filePath.setContent(etreeToString(directoryNode, &quot;utf-8&quot;))
</del><ins>+        self.filePath.setContent(&quot;{preamble}\n{xml}\n&quot;.format(preamble=self.filePreamble, xml=etreeToString(directoryNode, &quot;utf-8&quot;)))
</ins><span class="cx">         self.flush()
</span><span class="cx"> 
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>