<!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>[11970] CalendarServer/trunk/twext/who</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/11970">11970</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-11-19 08:45:53 -0800 (Tue, 19 Nov 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add an indexRecords() method and remove ability to set the index.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktwextwhoindexpy">CalendarServer/trunk/twext/who/index.py</a></li>
<li><a href="#CalendarServertrunktwextwhotesttest_indexpy">CalendarServer/trunk/twext/who/test/test_index.py</a></li>
<li><a href="#CalendarServertrunktwextwhoxmlpy">CalendarServer/trunk/twext/who/xml.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktwextwhoindexpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/who/index.py (11969 => 11970)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/who/index.py        2013-11-19 05:59:39 UTC (rev 11969)
+++ CalendarServer/trunk/twext/who/index.py        2013-11-19 16:45:53 UTC (rev 11970)
</span><span class="lines">@@ -172,34 +172,62 @@
</span><span class="cx">         return self._index
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-    @index.setter
-    def index(self, value):
</del><ins>+    def loadRecords(self):
</ins><span class="cx">         &quot;&quot;&quot;
</span><del>-        Sets the index.
</del><ins>+        Load records.  This method is called by the L{index} property and
+        provides a hook into which the index can be updated.
</ins><span class="cx"> 
</span><del>-        @param index: An index.
-        @type index: L{dict}
</del><ins>+        This method must be implemented by subclasses.
+
+        An example implementation::
+
+            def loadRecords(self):
+                self.flush()
+                while True:
+                    records = readSomeRecordsFromMyBackEnd()
+                    if not records:
+                        break
+                    self.indexRecords(records)
</ins><span class="cx">         &quot;&quot;&quot;
</span><del>-        self._index = value
</del><ins>+        raise NotImplementedError(&quot;Subclasses must implement loadRecords().&quot;)
</ins><span class="cx"> 
</span><span class="cx"> 
</span><del>-    def loadRecords(self):
</del><ins>+    def indexRecords(self, records):
</ins><span class="cx">         &quot;&quot;&quot;
</span><del>-        Load records.  This must be implemented by subclasses.
</del><ins>+        Add some records to the index.
</ins><span class="cx"> 
</span><del>-        The implementation should set the index property with current index
-        data.
</del><ins>+        @param records: The records to index.
+        @type records: iterable of L{DirectoryRecord}
</ins><span class="cx">         &quot;&quot;&quot;
</span><del>-        raise NotImplementedError(&quot;Subclasses must implement loadRecords().&quot;)
</del><ins>+        index = self._index
</ins><span class="cx"> 
</span><ins>+        for fieldName in self.indexedFields:
+            index.setdefault(fieldName, {})
</ins><span class="cx"> 
</span><ins>+        for record in records:
+            for fieldName in self.indexedFields:
+                values = record.fields.get(fieldName, None)
+
+                if values is not None:
+                    if not BaseFieldName.isMultiValue(fieldName):
+                        values = (values,)
+
+                    for value in values:
+                        index[fieldName].setdefault(value, set()).add(record)
+
+
</ins><span class="cx">     def flush(self):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         Flush the index.
</span><span class="cx">         &quot;&quot;&quot;
</span><del>-        self._index = None
</del><ins>+        index = {}
</ins><span class="cx"> 
</span><ins>+        for fieldName in self.indexedFields:
+            index.setdefault(fieldName, {})
</ins><span class="cx"> 
</span><ins>+        self._index = index
+
+
</ins><span class="cx">     def indexedRecordsFromMatchExpression(self, expression, records=None):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         Finds records in the internal indexes matching a single expression.
</span></span></pre></div>
<a id="CalendarServertrunktwextwhotesttest_indexpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/who/test/test_index.py (11969 => 11970)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/who/test/test_index.py        2013-11-19 05:59:39 UTC (rev 11969)
+++ CalendarServer/trunk/twext/who/test/test_index.py        2013-11-19 16:45:53 UTC (rev 11970)
</span><span class="lines">@@ -51,36 +51,24 @@
</span><span class="cx">         Index starts as C{None}.
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         service = self.service()
</span><del>-        self.assertIdentical(service._index, None)
</del><ins>+        self.assertTrue(emptyIndex(service._index))
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def test_index_get(self):
</span><span class="cx">         &quot;&quot;&quot;
</span><del>-        Getting the C{index} property calls C{loadRecords} and returns the
-        index set by C{loadRecords}.
</del><ins>+        Getting the C{index} property calls C{loadRecords}.
</ins><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         class TestService(DirectoryService):
</span><ins>+            loaded = False
+
</ins><span class="cx">             def loadRecords(self):
</span><del>-                self.index = self.indexToLoad
</del><ins>+                self.loaded = True
</ins><span class="cx"> 
</span><span class="cx">         service = TestService(u&quot;&quot;)
</span><ins>+        service.index
+        self.assertTrue(service.loaded)
</ins><span class="cx"> 
</span><del>-        for index in ({}, {}, {}):
-            service.indexToLoad = index
-            self.assertIdentical(service.index, index)
</del><span class="cx"> 
</span><del>-
-    def test_index_set(self):
-        &quot;&quot;&quot;
-        Setting the index and getting it gives us back the same value.
-        &quot;&quot;&quot;
-        service = NoLoadDirectoryService(u&quot;&quot;)
-
-        for index in ({}, {}, {}):
-            service.index = index
-            self.assertIdentical(service.index, index)
-
-
</del><span class="cx">     def test_loadRecords(self):
</span><span class="cx">         &quot;&quot;&quot;
</span><span class="cx">         L{DirectoryService.loadRecords} raises C{NotImplementedError}.
</span><span class="lines">@@ -96,7 +84,7 @@
</span><span class="cx">         service = NoLoadDirectoryService(u&quot;&quot;)
</span><span class="cx">         service._index = {}
</span><span class="cx">         service.flush()
</span><del>-        self.assertIdentical(service._index, None)
</del><ins>+        self.assertTrue(emptyIndex(service._index))
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def _noop(self):
</span><span class="lines">@@ -157,3 +145,24 @@
</span><span class="cx"> 
</span><span class="cx">     test_members_group = _noop
</span><span class="cx">     test_memberships = _noop
</span><ins>+
+
+
+def emptyIndex(index):
+    &quot;&quot;&quot;
+    Determine whether an index is empty.
+
+    @param index: An index.
+    @type index: L{dict}
+
+    @return: true if C{index} is empty, otherwise false.
+    &quot;&quot;&quot;
+    if not index:
+        return True
+
+    for fieldName, fieldIndex in index.iteritems():
+        for fieldValue, records in fieldIndex:
+            if records:
+                return False
+
+    return True
</ins></span></pre></div>
<a id="CalendarServertrunktwextwhoxmlpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/who/xml.py (11969 => 11970)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/who/xml.py        2013-11-19 05:59:39 UTC (rev 11969)
+++ CalendarServer/trunk/twext/who/xml.py        2013-11-19 16:45:53 UTC (rev 11970)
</span><span class="lines">@@ -242,7 +242,7 @@
</span><span class="cx">         if not realmName:
</span><span class="cx">             raise ParseError(&quot;No realm name.&quot;)
</span><span class="cx"> 
</span><del>-        unknownRecordTypes   = set()
</del><ins>+        unknownRecordTypes = set()
</ins><span class="cx">         unknownFieldElements = set()
</span><span class="cx"> 
</span><span class="cx">         records = set()
</span><span class="lines">@@ -259,32 +259,17 @@
</span><span class="cx">         # Store results
</span><span class="cx">         #
</span><span class="cx"> 
</span><del>-        index = {}
</del><ins>+        self.flush()
+        self.indexRecords(records)
</ins><span class="cx"> 
</span><del>-        for fieldName in self.indexedFields:
-            index[fieldName] = {}
-
-        for record in records:
-            for fieldName in self.indexedFields:
-                values = record.fields.get(fieldName, None)
-
-                if values is not None:
-                    if not BaseFieldName.isMultiValue(fieldName):
-                        values = (values,)
-
-                    for value in values:
-                        index[fieldName].setdefault(value, set()).add(record)
-
</del><span class="cx">         self._realmName = realmName
</span><span class="cx"> 
</span><del>-        self._unknownRecordTypes   = unknownRecordTypes
</del><ins>+        self._unknownRecordTypes = unknownRecordTypes
</ins><span class="cx">         self._unknownFieldElements = unknownFieldElements
</span><span class="cx"> 
</span><span class="cx">         self._cacheTag = cacheTag
</span><span class="cx">         self._lastRefresh = now
</span><span class="cx"> 
</span><del>-        self.index = index
-
</del><span class="cx">         return etree
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="lines">@@ -348,11 +333,11 @@
</span><span class="cx">     def flush(self):
</span><span class="cx">         BaseDirectoryService.flush(self)
</span><span class="cx"> 
</span><del>-        self._realmName            = None
-        self._unknownRecordTypes   = None
</del><ins>+        self._realmName = None
+        self._unknownRecordTypes = None
</ins><span class="cx">         self._unknownFieldElements = None
</span><del>-        self._cacheTag             = None
-        self._lastRefresh          = 0
</del><ins>+        self._cacheTag = None
+        self._lastRefresh = 0
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx">     def updateRecords(self, records, create=False):
</span></span></pre>
</div>
</div>

</body>
</html>