<!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>[12766] CalendarServer/trunk/calendarserver/webadmin</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/12766">12766</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-02-27 10:31:01 -0800 (Thu, 27 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Move to the right place</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadmineventsourcepy">CalendarServer/trunk/calendarserver/webadmin/eventsource.py</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadmintesteventsourcepy">CalendarServer/trunk/calendarserver/webadmin/test/eventsource.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverwebadmineventsourcepyfromrev12765CalendarServertrunkcalendarserverwebadmintesteventsourcepy"></a>
<div class="copfile"><h4>Copied: CalendarServer/trunk/calendarserver/webadmin/eventsource.py (from rev 12765, CalendarServer/trunk/calendarserver/webadmin/test/eventsource.py) (0 => 12766)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/eventsource.py (rev 0)
+++ CalendarServer/trunk/calendarserver/webadmin/eventsource.py 2014-02-27 18:31:01 UTC (rev 12766)
</span><span class="lines">@@ -0,0 +1,225 @@
</span><ins>+# -*- test-case-name: calendarserver.webadmin.test.test_principals -*-
+##
+# Copyright (c) 2014 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+from __future__ import print_function
+
+"""
+Calendar Server principal management web UI.
+"""
+
+__all__ = [
+ "textAsEvent",
+ "EventSourceResource",
+]
+
+from collections import deque
+
+from zope.interface import implementer, Interface
+
+from twisted.internet.defer import succeed
+
+from txweb2.stream import IByteStream, fallbackSplit
+from txweb2.resource import Resource
+from txweb2.http_headers import MimeType
+from txweb2.http import Response
+
+
+
+def textAsEvent(text, eventID=None, eventClass=None):
+ """
+ Format some text as an HTML5 EventSource event. Since the EventSource data
+ format is text-oriented, this function expects L{unicode}, not L{bytes};
+ binary data should be encoded as text if it is to be used in an EventSource
+ stream.
+
+ @param text: The text (ie. the message) to send in the event.
+ @type text: L{unicode}
+
+ @param eventID: An unique identifier for the event.
+ @type eventID: L{unicode}
+
+ @param eventClass: A class name (ie. a categorization) for the event.
+ @type eventClass: L{unicode}
+
+ @return: An HTML5 EventSource event as text.
+ @rtype: L{unicode}
+ """
+ event = []
+
+ if eventID is not None:
+ event.append(u"id: {0}".format(eventID))
+
+ if eventClass is not None:
+ event.append(u"event: {0}".format(eventClass))
+
+ event.extend(
+ u"data: {0}".format(l) for l in text.split("\n")
+ )
+
+ return u"\n".join(event) + u"\n\n"
+
+
+
+class IEventDecoder(Interface):
+ """
+ An object that can be used to extract data from an application-specific
+ event object for encoding into an EventSource data stream.
+ """
+
+ def idForEvent(event):
+ """
+ @return: An unique identifier for the given event.
+ @rtype: L{unicode}
+ """
+
+ def classForEvent(event):
+ """
+ @return: A class name (ie. a categorization) for the event.
+ @rtype: L{unicode}
+ """
+
+ def textForEvent(event):
+ """
+ @return: The text (ie. the message) to send in the event.
+ @rtype: L{unicode}
+ """
+
+
+
+class EventSourceResource(Resource):
+ """
+ Resource that vends HTML5 EventSource events.
+
+ Events are stored in a ring buffer and streamed to clients.
+ """
+
+ addSlash = False
+
+
+ def __init__(self, eventDecoder, bufferSize=400):
+ """
+ @param eventDecoder: An object that can be used to extract data from
+ an event for encoding into an EventSource data stream.
+ @type eventDecoder: L{IEventDecoder}
+
+ @param bufferSize: The maximum number of events to keep in the ring
+ buffer.
+ @type bufferSize: L{int}
+ """
+ Resource.__init__(self)
+
+ self._events = deque(maxlen=bufferSize)
+
+
+ def render(self, request):
+ lastID = request.headers.getRawHeaders(u"last-event-id")
+
+ response = Response()
+ response.stream = EventStream(self._eventDecoder, self._events, lastID)
+ response.headers.setHeader(
+ b"content-type", MimeType.fromString(b"text/event-stream")
+ )
+ return response
+
+
+
+@implementer(IByteStream)
+class EventStream(object):
+ """
+ L{IByteStream} that streams out HTML5 EventSource events.
+ """
+
+ length = None
+
+
+ def __init__(self, eventDecoder, events, lastID):
+ """
+ @param eventDecoder: An object that can be used to extract data from
+ an event for encoding into an EventSource data stream.
+ @type eventDecoder: L{IEventDecoder}
+
+ @param events: Application-specific event objects.
+ @type events: sequence of L{object}
+
+ @param lastID: The identifier for the last event that was vended from
+ C{events}. Vending will resume starting from the following event.
+ @type lastID: L{int}
+ """
+ object.__init__(self)
+
+ self._eventDecoder = eventDecoder
+ self._events = events
+ self._lastID = lastID
+ self._closed = False
+
+
+ def addEvent(self, event):
+ self._events.append(event)
+
+
+ def read(self):
+ if self._closed:
+ return None
+
+ lastID = self._lastID
+ eventID = None
+
+ idForEvent = self.eventDecoder.idForEvent
+ classForEvent = self.eventDecoder.classForEvent
+ textForEvent = self.eventDecoder.textForEvent
+
+ for event in self._events:
+ eventID = idForEvent(event)
+
+ # If lastID is not None, skip messages up to and including the one
+ # referenced by lastID.
+ if lastID is not None:
+ if eventID == lastID:
+ eventID = None
+ lastID = None
+
+ continue
+
+ eventClass = classForEvent(event)
+ eventText = textForEvent(event)
+
+ return succeed(
+ textAsEvent(eventText, eventID, eventClass).encode("utf-8")
+ )
+
+
+ if eventID is not None:
+ # We just scanned all the messages, and none are the last one the
+ # client saw.
+ self._lastID = None
+
+ return succeed("")
+
+ return succeed(None)
+
+ # from twisted.internet.task import deferLater
+ # from twisted.internet import reactor
+
+ # return deferLater(reactor, 1.0, self.read)
+
+
+ def split(self, point):
+ return fallbackSplit(self, point)
+
+
+ def close(self):
+ self._closed = True
</ins></span></pre></div>
<a id="CalendarServertrunkcalendarserverwebadmintesteventsourcepy"></a>
<div class="delfile"><h4>Deleted: CalendarServer/trunk/calendarserver/webadmin/test/eventsource.py (12765 => 12766)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/test/eventsource.py 2014-02-27 18:30:37 UTC (rev 12765)
+++ CalendarServer/trunk/calendarserver/webadmin/test/eventsource.py 2014-02-27 18:31:01 UTC (rev 12766)
</span><span class="lines">@@ -1,225 +0,0 @@
</span><del>-# -*- test-case-name: calendarserver.webadmin.test.test_principals -*-
-##
-# Copyright (c) 2014 Apple Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-##
-
-from __future__ import print_function
-
-"""
-Calendar Server principal management web UI.
-"""
-
-__all__ = [
- "textAsEvent",
- "EventSourceResource",
-]
-
-from collections import deque
-
-from zope.interface import implementer, Interface
-
-from twisted.internet.defer import succeed
-
-from txweb2.stream import IByteStream, fallbackSplit
-from txweb2.resource import Resource
-from txweb2.http_headers import MimeType
-from txweb2.http import Response
-
-
-
-def textAsEvent(text, eventID=None, eventClass=None):
- """
- Format some text as an HTML5 EventSource event. Since the EventSource data
- format is text-oriented, this function expects L{unicode}, not L{bytes};
- binary data should be encoded as text if it is to be used in an EventSource
- stream.
-
- @param text: The text (ie. the message) to send in the event.
- @type text: L{unicode}
-
- @param eventID: An unique identifier for the event.
- @type eventID: L{unicode}
-
- @param eventClass: A class name (ie. a categorization) for the event.
- @type eventClass: L{unicode}
-
- @return: An HTML5 EventSource event as text.
- @rtype: L{unicode}
- """
- event = []
-
- if eventID is not None:
- event.append(u"id: {0}".format(eventID))
-
- if eventClass is not None:
- event.append(u"event: {0}".format(eventClass))
-
- event.extend(
- u"data: {0}".format(l) for l in text.split("\n")
- )
-
- return u"\n".join(event) + u"\n\n"
-
-
-
-class IEventDecoder(Interface):
- """
- An object that can be used to extract data from an application-specific
- event object for encoding into an EventSource data stream.
- """
-
- def idForEvent(event):
- """
- @return: An unique identifier for the given event.
- @rtype: L{unicode}
- """
-
- def classForEvent(event):
- """
- @return: A class name (ie. a categorization) for the event.
- @rtype: L{unicode}
- """
-
- def textForEvent(event):
- """
- @return: The text (ie. the message) to send in the event.
- @rtype: L{unicode}
- """
-
-
-
-class EventSourceResource(Resource):
- """
- Resource that vends HTML5 EventSource events.
-
- Events are stored in a ring buffer and streamed to clients.
- """
-
- addSlash = False
-
-
- def __init__(self, eventDecoder, bufferSize=400):
- """
- @param eventDecoder: An object that can be used to extract data from
- an event for encoding into an EventSource data stream.
- @type eventDecoder: L{IEventDecoder}
-
- @param bufferSize: The maximum number of events to keep in the ring
- buffer.
- @type bufferSize: L{int}
- """
- Resource.__init__(self)
-
- self._events = deque(maxlen=bufferSize)
-
-
- def render(self, request):
- lastID = request.headers.getRawHeaders(u"last-event-id")
-
- response = Response()
- response.stream = EventStream(self._eventDecoder, self._events, lastID)
- response.headers.setHeader(
- b"content-type", MimeType.fromString(b"text/event-stream")
- )
- return response
-
-
-
-@implementer(IByteStream)
-class EventStream(object):
- """
- L{IByteStream} that streams out HTML5 EventSource events.
- """
-
- length = None
-
-
- def __init__(self, eventDecoder, events, lastID):
- """
- @param eventDecoder: An object that can be used to extract data from
- an event for encoding into an EventSource data stream.
- @type eventDecoder: L{IEventDecoder}
-
- @param events: Application-specific event objects.
- @type events: sequence of L{object}
-
- @param lastID: The identifier for the last event that was vended from
- C{events}. Vending will resume starting from the following event.
- @type lastID: L{int}
- """
- object.__init__(self)
-
- self._eventDecoder = eventDecoder
- self._events = events
- self._lastID = lastID
- self._closed = False
-
-
- def addEvent(self, event):
- self._events.append(event)
-
-
- def read(self):
- if self._closed:
- return None
-
- lastID = self._lastID
- eventID = None
-
- idForEvent = self.eventDecoder.idForEvent
- classForEvent = self.eventDecoder.classForEvent
- textForEvent = self.eventDecoder.textForEvent
-
- for event in self._events:
- eventID = idForEvent(event)
-
- # If lastID is not None, skip messages up to and including the one
- # referenced by lastID.
- if lastID is not None:
- if eventID == lastID:
- eventID = None
- lastID = None
-
- continue
-
- eventClass = classForEvent(event)
- eventText = textForEvent(event)
-
- return succeed(
- textAsEvent(eventText, eventID, eventClass).encode("utf-8")
- )
-
-
- if eventID is not None:
- # We just scanned all the messages, and none are the last one the
- # client saw.
- self._lastID = None
-
- return succeed("")
-
- return succeed(None)
-
- # from twisted.internet.task import deferLater
- # from twisted.internet import reactor
-
- # return deferLater(reactor, 1.0, self.read)
-
-
- def split(self, point):
- return fallbackSplit(self, point)
-
-
- def close(self):
- self._closed = True
</del></span></pre>
</div>
</div>
</body>
</html>