<!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>[12774] CalendarServer/trunk/calendarserver/webadmin/logs.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/12774">12774</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-02-27 16:24:11 -0800 (Thu, 27 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Use new eventsource module.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadminlogspy">CalendarServer/trunk/calendarserver/webadmin/logs.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverwebadminlogspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/webadmin/logs.py (12773 => 12774)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/logs.py 2014-02-28 00:23:44 UTC (rev 12773)
+++ CalendarServer/trunk/calendarserver/webadmin/logs.py 2014-02-28 00:24:11 UTC (rev 12774)
</span><span class="lines">@@ -26,20 +26,13 @@
</span><span class="cx"> "LogEventsResource",
</span><span class="cx"> ]
</span><span class="cx">
</span><del>-from collections import deque
-
</del><span class="cx"> from zope.interface import implementer
</span><span class="cx">
</span><span class="cx"> from twisted.python.log import FileLogObserver
</span><del>-from twisted.internet.defer import succeed
</del><span class="cx">
</span><del>-from txweb2.stream import IByteStream, fallbackSplit
-from txweb2.resource import Resource
-from txweb2.http_headers import MimeType
-from txweb2.http import Response
-
</del><span class="cx"> from calendarserver.accesslog import CommonAccessLoggingObserverExtensions
</span><span class="cx">
</span><ins>+from .eventsource import EventSourceResource, IEventDecoder
</ins><span class="cx"> from .resource import PageElement, TemplateResource
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -75,132 +68,64 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><del>-class LogEventsResource(Resource):
</del><ins>+@implementer(IEventDecoder)
+class EventDecoder(object):
</ins><span class="cx"> """
</span><del>- Log event vending resource.
</del><ins>+ Decodes logging events.
</ins><span class="cx"> """
</span><span class="cx">
</span><del>- addSlash = False
</del><ins>+ @staticmethod
+ def idForEvent(event):
+ observer, eventClass, logEvent = event
+ return id(logEvent)
</ins><span class="cx">
</span><span class="cx">
</span><del>- def __init__(self):
- Resource.__init__(self)
</del><ins>+ @staticmethod
+ def classForEvent(event):
+ observer, eventClass, logEvent = event
+ return eventClass
</ins><span class="cx">
</span><del>- events = deque(maxlen=400)
</del><span class="cx">
</span><del>- observers = (
- AccessLogObserver(events),
- ServerLogObserver(events),
- )
</del><ins>+ @staticmethod
+ def textForEvent(event):
+ observer, eventClass, logEvent = event
</ins><span class="cx">
</span><del>- for observer in observers:
- observer.start()
</del><ins>+ try:
+ if eventClass == u"access":
+ text = logEvent[u"log-format"] % logEvent
+ else:
+ text = observer.formatEvent(logEvent)
+ if text is None:
+ text = u""
+ except:
+ text = u"*** Error while formatting event ***"
</ins><span class="cx">
</span><del>- self.events = events
- self.observers = observers
</del><ins>+ return text
</ins><span class="cx">
</span><span class="cx">
</span><del>- def render(self, request):
- start = request.headers.getRawHeaders(u"last-event-id")
</del><span class="cx">
</span><del>- if start is not None:
- try:
- start = int(start[0])
- except ValueError:
- start = None
-
- response = Response()
- response.stream = LogEventStream(self, start=start)
- response.headers.setHeader(
- b"content-type", MimeType.fromString(b"text/event-stream")
- )
- return response
-
-
-
-@implementer(IByteStream)
-class LogEventStream(object):
</del><ins>+class LogEventsResource(EventSourceResource):
</ins><span class="cx"> """
</span><del>- L{IByteStream} that streams log events out as HTML5 EventSource events.
</del><ins>+ Log event vending resource.
</ins><span class="cx"> """
</span><span class="cx">
</span><del>- length = None
</del><ins>+ def __init__(self):
+ EventSourceResource.__init__(self, EventDecoder)
</ins><span class="cx">
</span><ins>+ self.observers = (
+ AccessLogObserver(self),
+ ServerLogObserver(self),
+ )
</ins><span class="cx">
</span><del>- def __init__(self, source, start):
- object.__init__(self)
</del><ins>+ for observer in self.observers:
+ observer.start()
</ins><span class="cx">
</span><del>- self._source = source
- self._start = start
- self._closed = False
</del><span class="cx">
</span><span class="cx">
</span><del>- def read(self):
- if self._closed:
- return None
-
- start = self._start
- messageID = None
-
- for observer, eventClass, event in tuple(self._source.events):
- messageID = id(event)
-
- # If we have a start point, skip messages up to and including the
- # one at the start point.
- if start is not None:
- if messageID == start:
- messageID = None
- start = None
-
- continue
-
- self._start = messageID
-
- if eventClass == u"access":
- message = event[u"log-format"] % event
- else:
- message = observer.formatEvent(event)
- if message is None:
- continue
-
- eventText = textAsEvent(
- message, eventID=messageID, eventClass=eventClass
- )
-
- return succeed(eventText)
-
- if messageID is not None:
- # We just scanned all the messages, and none are the last one the
- # client saw.
- self._start = None
-
- marker = "-"
-
- return succeed(
- textAsEvent(marker, eventID=0, eventClass=u"access") +
- textAsEvent(marker, eventID=0, eventClass=u"server")
- )
-
- 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 class="cx"> class ServerLogObserver(FileLogObserver):
</span><span class="cx"> """
</span><del>- Log observer that captures events in a buffer instead of writing to a file.
</del><ins>+ Log observer that sends events to an L{EventSourceResource} instead of
+ writing to a file.
</ins><span class="cx">
</span><span class="cx"> @note: L{ServerLogObserver} is an old-style log observer, as it inherits
</span><span class="cx"> from L{FileLogObserver}.
</span><span class="lines">@@ -209,7 +134,7 @@
</span><span class="cx"> timeFormat = None
</span><span class="cx">
</span><span class="cx">
</span><del>- def __init__(self, buffer):
</del><ins>+ def __init__(self, resource):
</ins><span class="cx"> class FooIO(object):
</span><span class="cx"> def write(_, s):
</span><span class="cx"> self._lastMessage = s
</span><span class="lines">@@ -220,18 +145,13 @@
</span><span class="cx"> FileLogObserver.__init__(self, FooIO())
</span><span class="cx">
</span><span class="cx"> self.lastMessage = None
</span><del>- self._buffer = buffer
- self._waiting = []
</del><ins>+ self._resource = resource
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def emit(self, event):
</span><del>- self._buffer.append((self, u"server", event))
</del><ins>+ self._resource.addEvents(((self, u"server", event),))
</ins><span class="cx">
</span><del>- while self._waiting:
- d = self._waiting.pop(0)
- d.callback(None)
</del><span class="cx">
</span><del>-
</del><span class="cx"> def formatEvent(self, event):
</span><span class="cx"> self._lastMessage = None
</span><span class="cx"> FileLogObserver.emit(self, event)
</span><span class="lines">@@ -248,10 +168,10 @@
</span><span class="cx"> ultimately inherits from L{txweb2.log.BaseCommonAccessLoggingObserver}.
</span><span class="cx"> """
</span><span class="cx">
</span><del>- def __init__(self, buffer):
</del><ins>+ def __init__(self, resource):
</ins><span class="cx"> CommonAccessLoggingObserverExtensions.__init__(self)
</span><span class="cx">
</span><del>- self._buffer = buffer
</del><ins>+ self._resource = resource
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def logStats(self, event):
</span><span class="lines">@@ -259,21 +179,4 @@
</span><span class="cx"> if event[u"type"] != u"access-log":
</span><span class="cx"> return
</span><span class="cx">
</span><del>- self._buffer.append((self, u"access", event))
-
-
-
-def textAsEvent(text, eventID=None, eventClass=None):
- 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).encode(u"utf-8") + "\n\n"
</del><ins>+ self._resource.addEvents(((self, u"access", event),))
</ins></span></pre>
</div>
</div>
</body>
</html>