<!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>[12816] CalendarServer/trunk/calendarserver/tools/jobitems.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/12816">12816</a></dd>
<dt>Author</dt> <dd>cdaboo@apple.com</dd>
<dt>Date</dt> <dd>2014-03-05 08:40:56 -0800 (Wed, 05 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Allow keyboard to control dashboard (e.g. q to quit). Add a help panel to show available keyboard options.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarservertoolsjobitemspy">CalendarServer/trunk/calendarserver/tools/jobitems.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarservertoolsjobitemspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/tools/jobitems.py (12815 => 12816)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/tools/jobitems.py 2014-03-05 15:45:13 UTC (rev 12815)
+++ CalendarServer/trunk/calendarserver/tools/jobitems.py 2014-03-05 16:40:56 UTC (rev 12816)
</span><span class="lines">@@ -17,15 +17,18 @@
</span><span class="cx"> ##
</span><span class="cx"> from __future__ import print_function
</span><span class="cx">
</span><ins>+from calendarserver.tools.cmdline import utilityMain, WorkerService
+
</ins><span class="cx"> from getopt import getopt, GetoptError
</span><ins>+
+from twext.enterprise.jobqueue import JobItem
+
+from twisted.internet.defer import inlineCallbacks, succeed
+
+import curses
</ins><span class="cx"> import os
</span><span class="cx"> import sys
</span><del>-import curses
</del><span class="cx">
</span><del>-from twisted.internet.defer import inlineCallbacks, succeed
-from calendarserver.tools.cmdline import utilityMain, WorkerService
-from twext.enterprise.jobqueue import JobItem
-
</del><span class="cx"> useCurses = True
</span><span class="cx">
</span><span class="cx"> def usage(e=None):
</span><span class="lines">@@ -86,28 +89,35 @@
</span><span class="cx"> else:
</span><span class="cx"> raise NotImplementedError(opt)
</span><span class="cx">
</span><del>- utilityMain(configFileName, JobItemMonitorService, verbose=debug)
</del><ins>+ if useCurses:
+ def _wrapped(stdscrn):
+ JobItemMonitorService.screen = stdscrn
+ curses.curs_set(0)
+ curses.use_default_colors()
+ utilityMain(configFileName, JobItemMonitorService, verbose=debug)
+ curses.wrapper(_wrapped)
+ else:
+ utilityMain(configFileName, JobItemMonitorService, verbose=debug)
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> class JobItemMonitorService(WorkerService, object):
</span><span class="cx">
</span><ins>+ screen = None
+
</ins><span class="cx"> def __init__(self, store):
</span><span class="cx"> super(JobItemMonitorService, self).__init__(store)
</span><span class="cx"> from twisted.internet import reactor
</span><span class="cx"> self.reactor = reactor
</span><ins>+ self.paused = False
+ self.seconds = 0.1
</ins><span class="cx">
</span><span class="cx">
</span><ins>+ @inlineCallbacks
</ins><span class="cx"> def doWork(self):
</span><del>- if useCurses:
- self.screen = curses.initscr()
- curses.curs_set(0)
- else:
- self.screen = None
- self.windows = []
- self.updateScreenGeometry()
</del><ins>+ self.window = None
+ yield self.displayJobs()
</ins><span class="cx"> self.reactor.callLater(0, self.updateDisplay)
</span><del>- return succeed(None)
</del><span class="cx">
</span><span class="cx">
</span><span class="cx"> def postStartService(self):
</span><span class="lines">@@ -117,30 +127,56 @@
</span><span class="cx"> pass
</span><span class="cx">
</span><span class="cx">
</span><del>- def updateScreenGeometry(self):
- for win in self.windows:
- del win
- window = WorkWindow(JobItem.numberOfWorkTypes() + 5, BOX_WIDTH, 0, 0, self.store, "Jobs")
- self.windows.append(window)
</del><ins>+ @inlineCallbacks
+ def displayHelp(self):
+ if self.window is not None:
+ self.window.clear()
+ self.window = HelpWindow(10, BOX_WIDTH, 0, 0, self.store, "Help")
+ yield self.window.update()
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><ins>+ def displayJobs(self):
+ if self.window is not None:
+ self.window.clear()
+ self.window = WorkWindow(JobItem.numberOfWorkTypes() + 5, BOX_WIDTH, 0, 0, self.store, "Jobs")
+ yield self.window.update()
+
+
+ @inlineCallbacks
</ins><span class="cx"> def updateDisplay(self):
</span><del>- for window in self.windows:
- try:
- yield window.update()
- except Exception as e:
- print(str(e))
</del><ins>+ try:
+ if not self.paused and self.window.requiresUpdate():
+ yield self.window.update()
+ except Exception as e:
+ print(str(e))
</ins><span class="cx"> if not useCurses:
</span><span class="cx"> print("-------------")
</span><span class="cx">
</span><del>- self.reactor.callLater(0.1, self.updateDisplay)
</del><ins>+ # Check keystrokes
+ try:
+ c = self.window.window.getkey()
+ except:
+ c = -1
+ if c == "q":
+ self.reactor.stop()
+ elif c == " ":
+ self.paused = not self.paused
+ elif c == "t":
+ self.seconds = 1.0 if self.seconds == 0.1 else 1.0
+ elif c == "h":
+ yield self.displayHelp()
+ elif c == "j":
+ yield self.displayJobs()
</ins><span class="cx">
</span><ins>+ self.reactor.callLater(self.seconds, self.updateDisplay)
</ins><span class="cx">
</span><span class="cx">
</span><del>-class WorkWindow(object):
</del><ins>+
+class BaseWindow(object):
</ins><span class="cx"> def __init__(self, nlines, ncols, begin_y, begin_x, store, title):
</span><span class="cx"> self.window = curses.newwin(nlines, ncols, begin_y, begin_x) if useCurses else None
</span><ins>+ self.window.nodelay(1)
</ins><span class="cx"> self.ncols = ncols
</span><span class="cx"> self.store = store
</span><span class="cx"> self.title = title
</span><span class="lines">@@ -148,6 +184,62 @@
</span><span class="cx"> self.lastResult = {}
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def requiresUpdate(self):
+ return True
+
+
+ def clear(self):
+
+ if useCurses:
+ self.window.erase()
+ self.window.refresh()
+
+
+ def update(self):
+ return succeed(True)
+
+
+
+class HelpWindow(BaseWindow):
+
+ def requiresUpdate(self):
+ return False
+
+
+ def update(self):
+
+ if useCurses:
+ self.window.erase()
+ self.window.border()
+ self.window.addstr(0, 2, "Help for Dashboard")
+
+ x = 1
+ y = 1
+
+ for title in (
+ "j - display server jobs",
+ "h - display dashboard help",
+ "",
+ " - (space) pause dashboard polling",
+ "t - toggle update between 0.1 and 1.0 seconds",
+ "",
+ "q - exit the dashboard",
+ ):
+ if useCurses:
+ self.window.addstr(y, x, title)
+ else:
+ print(title)
+ y += 1
+
+ if useCurses:
+ self.window.refresh()
+
+ return succeed(True)
+
+
+
+class WorkWindow(BaseWindow):
+
</ins><span class="cx"> @inlineCallbacks
</span><span class="cx"> def update(self):
</span><span class="cx"> txn = self.store.newTransaction()
</span></span></pre>
</div>
</div>
</body>
</html>