- tor-commits - lists.torproject.org

[arm/release] fix: correcting default control socket path
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit ee6721e5dfc19fd360313d4630efc1e3591b9364 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 08:18:05 2011 -0700 fix: correcting default control socket path According to dererk the default control socket path is "/var/run/tor/control" rather than "/var/lib/tor/control" (the path mentioned by Peter). --- armrc.sample | 2 +- src/cli/headerPanel.py | 2 +- src/starter.py | 2 +- src/util/torTools.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/armrc.sample b/armrc.sample index 22fb903..e19d4c4 100644 --- a/armrc.sample +++ b/armrc.sample @@ -2,7 +2,7 @@ startup.controlPassword startup.interface.ipAddress 127.0.0.1 startup.interface.port 9051 -startup.interface.socket /var/lib/tor/control +startup.interface.socket /var/run/tor/control startup.blindModeEnabled false startup.events N3 startup.dataDirectory ~/.arm diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index d5ce332..0e8c018 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -41,7 +41,7 @@ VERSION_STATUS_COLORS = {"new": "blue", "new in series": "blue", "obsolete": "re DEFAULT_CONFIG = {"startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, - "startup.interface.socket": "/var/lib/tor/control", + "startup.interface.socket": "/var/run/tor/control", "features.showFdUsage": False, "log.fdUsageSixtyPercent": log.NOTICE, "log.fdUsageNinetyPercent": log.WARN} diff --git a/src/starter.py b/src/starter.py index a148947..2bdc6d0 100644 --- a/src/starter.py +++ b/src/starter.py @@ -35,7 +35,7 @@ DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = {"startup.controlPassword": None, "startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, - "startup.interface.socket": "/var/lib/tor/control", + "startup.interface.socket": "/var/run/tor/control", "startup.blindModeEnabled": False, "startup.events": "N3", "startup.dataDirectory": "~/.arm", diff --git a/src/util/torTools.py b/src/util/torTools.py index 366deb0..39cb176 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -113,7 +113,7 @@ def loadConfig(config): # TODO: temporary code until this is added to torctl as part of... # https://trac.torproject.org/projects/tor/ticket/3638 -def connect_socket(socketPath="/var/lib/tor/control", ConnClass=TorCtl.Connection): +def connect_socket(socketPath="/var/run/tor/control", ConnClass=TorCtl.Connection): """ Connects to a unix domain socket available to controllers (set via tor's ControlSocket option). This raises an IOError if unable to do so.

1 0

[arm/release] fix: display control socket path in header panel
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit dc49b356cade11e38f0a826c6660b23883e4e99a Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 09:56:56 2011 -0700 fix: display control socket path in header panel Replacing the 'Control Port (<authType>): <port>' entry in the header panel with 'Control Socket: <socketPath>' when connected via a control socket. --- src/cli/headerPanel.py | 31 ++++++++++++++++++------------- 1 files changed, 18 insertions(+), 13 deletions(-) diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index 0e8c018..2c32af8 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -51,7 +51,7 @@ class HeaderPanel(panel.Panel, threading.Thread): Top area contenting tor settings and system information. Stats are stored in the vals mapping, keys including: tor/ version, versionStatus, nickname, orPort, dirPort, controlPort, - exitPolicy, isAuthPassword (bool), isAuthCookie (bool), + socketPath, exitPolicy, isAuthPassword (bool), isAuthCookie (bool), orListenAddr, *address, *fingerprint, *flags, pid, startTime, *fdUsed, fdLimit, isFdLimitEstimate sys/ hostname, os, version @@ -239,17 +239,21 @@ class HeaderPanel(panel.Panel, threading.Thread): includeControlPort = False if includeControlPort: - if self.vals["tor/isAuthPassword"]: authType = "password" - elif self.vals["tor/isAuthCookie"]: authType = "cookie" - else: authType = "open" - - if x + 19 + len(self.vals["tor/controlPort"]) + len(authType) <= leftWidth: - authColor = "red" if authType == "open" else "green" - self.addstr(1, x, ", Control Port (") - self.addstr(1, x + 16, authType, uiTools.getColor(authColor)) - self.addstr(1, x + 16 + len(authType), "): %s" % self.vals["tor/controlPort"]) - elif x + 16 + len(self.vals["tor/controlPort"]) <= leftWidth: - self.addstr(1, 0, ", Control Port: %s" % self.vals["tor/controlPort"]) + if self.vals["tor/controlPort"] == "0": + # connected via a control socket + self.addstr(1, x, ", Control Socket: %s" % self.vals["tor/socketPath"]) + else: + if self.vals["tor/isAuthPassword"]: authType = "password" + elif self.vals["tor/isAuthCookie"]: authType = "cookie" + else: authType = "open" + + if x + 19 + len(self.vals["tor/controlPort"]) + len(authType) <= leftWidth: + authColor = "red" if authType == "open" else "green" + self.addstr(1, x, ", Control Port (") + self.addstr(1, x + 16, authType, uiTools.getColor(authColor)) + self.addstr(1, x + 16 + len(authType), "): %s" % self.vals["tor/controlPort"]) + elif x + 16 + len(self.vals["tor/controlPort"]) <= leftWidth: + self.addstr(1, 0, ", Control Port: %s" % self.vals["tor/controlPort"]) # Line 3 / Line 1 Right (system usage info) y, x = (0, leftWidth) if isWide else (2, 0) @@ -474,7 +478,8 @@ class HeaderPanel(panel.Panel, threading.Thread): self.vals["tor/nickname"] = conn.getOption("Nickname", "") self.vals["tor/orPort"] = conn.getOption("ORPort", "0") self.vals["tor/dirPort"] = conn.getOption("DirPort", "0") - self.vals["tor/controlPort"] = conn.getOption("ControlPort", "") + self.vals["tor/controlPort"] = conn.getOption("ControlPort", "0") + self.vals["tor/socketPath"] = conn.getOption("ControlSocket", "") self.vals["tor/isAuthPassword"] = conn.getOption("HashedControlPassword") != None self.vals["tor/isAuthCookie"] = conn.getOption("CookieAuthentication") == "1"

1 0

[arm/release] fix: incorrect path for armrc in man page
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 250c5a76eefe92fc4e3c8b7fbde78b56829b91ff Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 09:03:58 2011 -0700 fix: incorrect path for armrc in man page The path hadn't been updated to reflect that it's in the default arm data directory (~/.arm). Caught by dererk --- src/resources/arm.1 | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/resources/arm.1 b/src/resources/arm.1 index 7edb5ef..3b8cfd4 100644 --- a/src/resources/arm.1 +++ b/src/resources/arm.1 @@ -62,7 +62,7 @@ provides usage information .SH FILES .TP -\fB~/.armrc\fR +\fB~/.arm/armrc\fR Your personal arm configuration file .TP

1 0

[arm/release] Wizard components for a startup option
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 6cc6ede6e19c28b5df1b0c88288ce3da20f0f84c Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 12 09:48:43 2011 -0700 Wizard components for a startup option This adds platform detection and a check for the system torrc option for the wizard startup option. However, this still isn't enabled nor is the option implemented (so this has no impact on users). I'm suspecting that system startup is a bigger can of worms than I'd like to open right now, even if restricted to Debian and Ubuntu platforms so gonna leave the rest unimplemented for now... --- src/cli/wizard.py | 34 +++++++++++++++++++++++++++------- src/resources/torrcTemplate.txt | 2 +- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 82b2825..40cf632 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -9,6 +9,7 @@ import sys import random import shutil import getpass +import platform import functools import curses @@ -283,22 +284,29 @@ def showWizard(): config[Options.REUSE].setValidator(_circDurationValidator) # enables custom policies when 'custom' is selected and disables otherwise - lowPortsOpt = config[Options.LOWPORTS] - disclaimerNotice = [config[Options.NOTICE]] - lowPortsOpt.setValidator(functools.partial(_toggleEnabledAction, disclaimerNotice)) - _toggleEnabledAction(disclaimerNotice, lowPortsOpt, lowPortsOpt.getValue()) - policyOpt = config[Options.POLICY] customPolicies = [config[opt] for opt in CUSTOM_POLICIES] policyOpt.setValidator(functools.partial(_toggleEnabledAction, customPolicies)) _toggleEnabledAction(customPolicies, policyOpt, policyOpt.getValue()) + lowPortsOpt = config[Options.LOWPORTS] + disclaimerNotice = [config[Options.NOTICE]] + lowPortsOpt.setValidator(functools.partial(_toggleEnabledAction, disclaimerNotice)) + _toggleEnabledAction(disclaimerNotice, lowPortsOpt, lowPortsOpt.getValue()) + # enables bridge entries when "Use Bridges" is set and disables otherwise useBridgeOpt = config[Options.BRIDGED] bridgeEntries = [config[opt] for opt in BRIDGE_ENTRIES] useBridgeOpt.setValidator(functools.partial(_toggleEnabledAction, bridgeEntries)) _toggleEnabledAction(bridgeEntries, useBridgeOpt, useBridgeOpt.getValue()) + # enables running at startup when 'Use System Instance' is deselected and + # disables otherwise + systemOpt = config[Options.SYSTEM] + startupOpt = [config[Options.STARTUP]] + systemOpt.setValidator(functools.partial(_toggleEnabledAction, startupOpt, True)) + _toggleEnabledAction(startupOpt, systemOpt, not systemOpt.getValue()) + # remembers the last selection made on the type prompt page controller = cli.controller.getController() manager = controller.getTorManager() @@ -318,11 +326,16 @@ def showWizard(): # If we haven't run 'resources/torrcOverride/override.py --init' or lack # permissions then we aren't able to deal with the system wide tor instance. - # Also drop the optoin if we aren't installed since override.py won't be at + # Also drop the option if we aren't installed since override.py won't be at # the expected path. if not os.path.exists(os.path.dirname(SYSTEM_DROP_PATH)) or not os.path.exists(OVERRIDE_SCRIPT): disabledOpt.append(Options.SYSTEM) + # Running at startup is currently only supported for Debian and Ubuntu. + # Patches welcome for supporting other platforms. + if not platform.dist()[0] in ("debian", "Ubuntu"): + disabledOpt.append(Options.STARTUP) + while True: if relayType == None: selection = promptRelayType(relaySelection) @@ -742,6 +755,10 @@ def getTorrc(relayType, config, disabledOpt): if opt.upper() in templateOptions: del templateOptions[opt.upper()] + startupOpt = Options.STARTUP.upper() + if not config[Options.STARTUP].isEnabled() and startupOpt in templateOptions: + del templateOptions[startupOpt] + # removes options if they match the tor defaults for opt in TOR_DEFAULTS: if templateOptions[opt.upper()] == TOR_DEFAULTS[opt]: @@ -919,7 +936,7 @@ def _obscureChar(inputText, target, options): return inputText.replace(target, replacement) -def _toggleEnabledAction(toggleOptions, option, value): +def _toggleEnabledAction(toggleOptions, option, value, invert = False): """ Enables or disables custom exit policy options based on our selection. @@ -928,8 +945,11 @@ def _toggleEnabledAction(toggleOptions, option, value): selection (ie, true -> enabled, false -> disabled) options - our config option value - the value we're being set to + invert - inverts selection if true """ + if invert: value = not value + for opt in toggleOptions: opt.setEnabled(value) diff --git a/src/resources/torrcTemplate.txt b/src/resources/torrcTemplate.txt index 744a481..c6e61f0 100644 --- a/src/resources/torrcTemplate.txt +++ b/src/resources/torrcTemplate.txt @@ -22,7 +22,7 @@ CookieAuthentication 1 # method for controller authentication [IF RELAY | EXIT | BRIDGE] RunAsDaemon 1 # runs as a background process - [IF LOWPORTS] + [IF LOWPORTS | STARTUP] User [USERNAME] # lowers our permissions to this user [END IF] [END IF]

1 0

[arm/release] fix: quitting could cause unclean curses shutdown
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 61273dee395e4ba0969d93b194ab728ffb2fbc7f Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 08:49:03 2011 -0700 fix: quitting could cause unclean curses shutdown If the user quit arm while we're processing tor events then there was a rather common timing issue where curses would terminate, then a daemon thread triggered a curses redraw. The result was that the terminal would be screwed up until the user ran 'reset'. This was because the daemon shutdown was outside of the curses wrapper function. Changing the ordering so we shut down daemons before curses, and setting a flag during keyboard interrupts to suppress curses redraws. --- src/cli/controller.py | 11 +++++++++-- src/util/panel.py | 7 +++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 8b87b1d..d2194ca 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -675,9 +675,14 @@ def startTorMonitor(startTime): try: curses.wrapper(drawTorMonitor, startTime) - shutdownDaemons() except KeyboardInterrupt: - # skip printing stack trace in case of keyboard interrupt + # Skip printing stack trace in case of keyboard interrupt. The + # HALT_ACTIVITY attempts to prevent daemons from triggering a curses redraw + # (which would leave the user's terminal in a screwed up state). There is + # still a tiny timing issue here (after the exception but before the flag + # is set) but I've never seen it happen in practice. + + panel.HALT_ACTIVITY = True shutdownDaemons() def drawTorMonitor(stdscr, startTime): @@ -772,4 +777,6 @@ def drawTorMonitor(stdscr, startTime): for panelImpl in displayPanels: isKeystrokeConsumed = panelImpl.handleKey(key) if isKeystrokeConsumed: break + + shutdownDaemons() diff --git a/src/util/panel.py b/src/util/panel.py index 732610c..8a95479 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -25,6 +25,9 @@ for colorLabel in uiTools.COLOR_LIST: FORMAT_TAGS["<%s>" % colorLabel] = (uiTool CONFIG = {"log.panelRecreated": log.DEBUG} +# prevents curses redraws if set +HALT_ACTIVITY = False + def loadConfig(config): config.update(CONFIG) @@ -375,8 +378,8 @@ class Panel(): abandoned """ - # skipped if not currently visible - if not self.isVisible(): return + # skipped if not currently visible or activity has been halted + if not self.isVisible() or HALT_ACTIVITY: return # if the panel's completely outside its parent then this is a no-op newHeight, newWidth = self.getPreferredSize()

1 0

[arm/release] fix: selecting a non-existant option crashed
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 0964e3e0c1780f91935195d45120ecda3f556765 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 12 09:56:20 2011 -0700 fix: selecting a non-existant option crashed When not attached to a tor instance there weren't any tor configuration options available. If the user pressed 'enter' to edit an option this crashed arm. --- src/cli/configPanel.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index 2e8e1c1..bd9cba9 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -321,7 +321,7 @@ class ConfigPanel(panel.Panel): isChanged = self.scroller.handleKey(key, self._getConfigOptions(), pageHeight) if isChanged: self.redraw(True) - elif uiTools.isSelectionKey(key): + elif uiTools.isSelectionKey(key) and self._getConfigOptions(): # Prompts the user to edit the selected configuration value. The # interface is locked to prevent updates between setting the value # and showing any errors.

1 0

[arm/release] fix: switching hotkey for saving config to 'v'
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 7c04d48fd8054790c84b1b85cd11d91d72bff35d Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 12 09:59:38 2011 -0700 fix: switching hotkey for saving config to 'v' The previous 'w' keybinding conflicted with the relay setup wizard so picking another. --- src/cli/configPanel.py | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index bd9cba9..31118c9 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -366,7 +366,7 @@ class ConfigPanel(panel.Panel): self.redraw(True) elif key == ord('s') or key == ord('S'): self.showSortDialog() - elif key == ord('w') or key == ord('W'): + elif key == ord('v') or key == ord('V'): self.showWriteDialog() else: isKeystrokeConsumed = False @@ -483,7 +483,7 @@ class ConfigPanel(panel.Panel): options.append(("page up", "scroll up a page", None)) options.append(("page down", "scroll down a page", None)) options.append(("enter", "edit configuration option", None)) - options.append(("w", "save configuration", None)) + options.append(("v", "save configuration", None)) options.append(("a", "toggle option filtering", None)) options.append(("s", "sort ordering", None)) return options

1 0

[arm/release] Rewrite of the descriptor popup dialog
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 9b9ea8e1d247ef5290ab730cf7a88d76d94d8f02 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Aug 15 10:11:00 2011 -0700 Rewrite of the descriptor popup dialog For a time I'd been planning to drop the descriptor popup from the codebase. However, it's fairly useful so cleaning up the code and keeping it. This is functionally equivilant except that it's a bit simpler and has minor performance improvements. --- README | 10 +- src/cli/__init__.py | 2 +- src/cli/connections/__init__.py | 2 +- src/cli/connections/connPanel.py | 14 ++- src/cli/connections/descriptorPopup.py | 229 ++++++++++++++++++++++++++++++++ src/cli/descriptorPopup.py | 216 ------------------------------ src/util/panel.py | 2 + 7 files changed, 248 insertions(+), 227 deletions(-) diff --git a/README b/README index 2e0bd6e..119d24e 100644 --- a/README +++ b/README @@ -171,10 +171,11 @@ Layout: connections/ __init__.py - connPanel.py - (page 2) lists the active tor connections - circEntry.py - circuit entries in the connection panel - connEntry.py - individual connections to or from the system - entries.py - common parent for connPanel display entries + connPanel.py - (page 2) lists the active tor connections + circEntry.py - circuit entries in the connection panel + connEntry.py - individual connections to or from the system + descriptorPopup.py - displays raw descriptor and consensus entries + entries.py - common parent for connPanel display entries menu/ __init__.py @@ -185,7 +186,6 @@ Layout: __init__.py controller.py - main display loop, handling input and layout headerPanel.py - top of all pages, providing general information - descriptorPopup.py - displays connection descriptor data popups.py - toolkit providing display popups wizard.py - provides the relay setup wizard diff --git a/src/cli/__init__.py b/src/cli/__init__.py index 435883d..b0d6bd8 100644 --- a/src/cli/__init__.py +++ b/src/cli/__init__.py @@ -2,5 +2,5 @@ Panels, popups, and handlers comprising the arm user interface. """ -__all__ = ["configPanel", "controller", "descriptorPopup", "headerPanel", "logPanel", "popups", "torrcPanel", "wizard"] +__all__ = ["configPanel", "controller", "headerPanel", "logPanel", "popups", "torrcPanel", "wizard"] diff --git a/src/cli/connections/__init__.py b/src/cli/connections/__init__.py index 5babdde..0f29d23 100644 --- a/src/cli/connections/__init__.py +++ b/src/cli/connections/__init__.py @@ -2,5 +2,5 @@ Connection panel related resources. """ -__all__ = ["circEntry", "connEntry", "connPanel", "entries"] +__all__ = ["circEntry", "connEntry", "connPanel", "descriptorPopup", "entries"] diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 705fd77..923902c 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -6,10 +6,9 @@ import time import curses import threading -import cli.descriptorPopup import cli.popups -from cli.connections import entries, connEntry, circEntry +from cli.connections import descriptorPopup, entries, connEntry, circEntry from util import connections, enum, panel, torTools, uiTools DEFAULT_CONFIG = {"features.connection.resolveApps": True, @@ -214,7 +213,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): if selection != -1: self.setListingType(options[selection]) elif key == ord('d') or key == ord('D'): # presents popup for raw consensus data - cli.descriptorPopup.showDescriptorPopup(self) + descriptorPopup.showDescriptorPopup(self) else: isKeystrokeConsumed = False self.valsLock.release() @@ -269,6 +268,13 @@ class ConnectionPanel(panel.Panel, threading.Thread): options.append(("u", "resolving utility", resolverUtil)) return options + def getSelection(self): + """ + Provides the currently selected connection entry. + """ + + return self._scroller.getCursorSelection(self._entryLines) + def draw(self, width, height): self.valsLock.acquire() @@ -280,7 +286,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): isScrollbarVisible = len(self._entryLines) > height - detailPanelOffset - 1 scrollLoc = self._scroller.getScrollLoc(self._entryLines, height - detailPanelOffset - 1) - cursorSelection = self._scroller.getCursorSelection(self._entryLines) + cursorSelection = self.getSelection() # draws the detail panel if currently displaying it if self._showDetails and cursorSelection: diff --git a/src/cli/connections/descriptorPopup.py b/src/cli/connections/descriptorPopup.py new file mode 100644 index 0000000..eed213f --- /dev/null +++ b/src/cli/connections/descriptorPopup.py @@ -0,0 +1,229 @@ +""" +Popup providing the raw descriptor and consensus information for a relay. +""" + +import math +import curses + +import cli.popups +import cli.connections.connEntry + +from util import panel, torTools, uiTools + +# field keywords used to identify areas for coloring +LINE_NUM_COLOR = "yellow" +HEADER_COLOR = "cyan" +HEADER_PREFIX = ["ns/id/", "desc/id/"] + +SIG_COLOR = "red" +SIG_START_KEYS = ["-----BEGIN RSA PUBLIC KEY-----", "-----BEGIN SIGNATURE-----"] +SIG_END_KEYS = ["-----END RSA PUBLIC KEY-----", "-----END SIGNATURE-----"] + +UNRESOLVED_MSG = "No consensus data available" +ERROR_MSG = "Unable to retrieve data" + +def showDescriptorPopup(connPanel): + """ + Presents consensus descriptor in popup window with the following controls: + Up, Down, Page Up, Page Down - scroll descriptor + Right, Left - next / previous connection + Enter, Space, d, D - close popup + + Arguments: + connPanel - connection panel providing the dialog + """ + + # hides the title of the connection panel + connPanel.setTitleVisible(False) + connPanel.redraw(True) + + control = cli.controller.getController() + panel.CURSES_LOCK.acquire() + isDone = False + + try: + while not isDone: + selection = connPanel.getSelection() + if not selection: break + + fingerprint = selection.foreign.getFingerprint() + if fingerprint == "UNKNOWN": fingerprint = None + + displayText = getDisplayText(fingerprint) + displayColor = cli.connections.connEntry.CATEGORY_COLOR[selection.getType()] + showLineNumber = fingerprint != None + + # determines the maximum popup size the displayText can fill + pHeight, pWidth = getPreferredSize(displayText, connPanel.maxX, showLineNumber) + + popup, _, height = cli.popups.init(pHeight, pWidth) + if not popup: break + scroll, isChanged = 0, True + + try: + while not isDone: + if isChanged: + draw(popup, fingerprint, displayText, displayColor, scroll, showLineNumber) + isChanged = False + + key = control.getScreen().getch() + + if uiTools.isScrollKey(key): + # TODO: This is a bit buggy in that scrolling is by displayText + # lines rather than the displayed lines, causing issues when + # content wraps. The result is that we can't have a scrollbar and + # can't scroll to the bottom if there's a multi-line being + # displayed. However, trying to correct this introduces a big can + # of worms and after hours decided that this isn't worth the + # effort... + + newScroll = uiTools.getScrollPosition(key, scroll, height - 2, len(displayText)) + + if scroll != newScroll: + scroll, isChanged = newScroll, True + elif uiTools.isSelectionKey(key) or key in (ord('d'), ord('D')): + isDone = True # closes popup + elif key in (curses.KEY_LEFT, curses.KEY_RIGHT): + # navigation - pass on to connPanel and recreate popup + connPanel.handleKey(curses.KEY_UP if key == curses.KEY_LEFT else curses.KEY_DOWN) + break + finally: cli.popups.finalize() + finally: + connPanel.setTitleVisible(True) + connPanel.redraw(True) + panel.CURSES_LOCK.release() + +def getDisplayText(fingerprint): + """ + Provides the descriptor and consensus entry for a relay. This is a list of + lines to be displayed by the dialog. + """ + + if not fingerprint: return [UNRESOLVED_MSG] + conn, description = torTools.getConn(), [] + + description.append("ns/id/%s" % fingerprint) + consensusEntry = conn.getConsensusEntry(fingerprint) + + if consensusEntry: description += consensusEntry.split("\n") + else: description += [ERROR_MSG, ""] + + description.append("desc/id/%s" % fingerprint) + descriptorEntry = conn.getDescriptorEntry(fingerprint) + + if descriptorEntry: description += descriptorEntry.split("\n") + else: description += [ERROR_MSG] + + return description + +def getPreferredSize(text, maxWidth, showLineNumber): + """ + Provides the (height, width) tuple for the preferred size of the given text. + """ + + width, height = 0, len(text) + 2 + lineNumWidth = int(math.log10(len(text))) + 1 + for line in text: + # width includes content, line number field, and border + lineWidth = len(line) + 5 + if showLineNumber: lineWidth += lineNumWidth + width = max(width, lineWidth) + + # tracks number of extra lines that will be taken due to text wrap + height += (lineWidth - 2) / maxWidth + + return (height, width) + +def draw(popup, fingerprint, displayText, displayColor, scroll, showLineNumber): + popup.win.erase() + popup.win.box() + xOffset = 2 + + if fingerprint: title = "Consensus Descriptor (%s):" % fingerprint + else: title = "Consensus Descriptor:" + popup.addstr(0, 0, title, curses.A_STANDOUT) + + lineNumWidth = int(math.log10(len(displayText))) + 1 + isEncryptionBlock = False # flag indicating if we're currently displaying a key + + # checks if first line is in an encryption block + for i in range(0, scroll): + lineText = displayText[i].strip() + if lineText in SIG_START_KEYS: isEncryptionBlock = True + elif lineText in SIG_END_KEYS: isEncryptionBlock = False + + drawLine, pageHeight = 1, popup.maxY - 2 + for i in range(scroll, scroll + pageHeight): + lineText = displayText[i].strip() + xOffset = 2 + + if showLineNumber: + lineNumLabel = ("%%%ii" % lineNumWidth) % (i + 1) + lineNumFormat = curses.A_BOLD | uiTools.getColor(LINE_NUM_COLOR) + + popup.addstr(drawLine, xOffset, lineNumLabel, lineNumFormat) + xOffset += lineNumWidth + 1 + + # Most consensus and descriptor lines are keyword/value pairs. Both are + # shown with the same color, but the keyword is bolded. + + keyword, value = lineText, "" + drawFormat = uiTools.getColor(displayColor) + + if lineText.startswith(HEADER_PREFIX[0]) or lineText.startswith(HEADER_PREFIX[1]): + keyword, value = lineText, "" + drawFormat = uiTools.getColor(HEADER_COLOR) + elif lineText == UNRESOLVED_MSG or lineText == ERROR_MSG: + keyword, value = lineText, "" + elif lineText in SIG_START_KEYS: + keyword, value = lineText, "" + isEncryptionBlock = True + drawFormat = uiTools.getColor(SIG_COLOR) + elif lineText in SIG_END_KEYS: + keyword, value = lineText, "" + isEncryptionBlock = False + drawFormat = uiTools.getColor(SIG_COLOR) + elif isEncryptionBlock: + keyword, value = "", lineText + drawFormat = uiTools.getColor(SIG_COLOR) + elif " " in lineText: + divIndex = lineText.find(" ") + keyword, value = lineText[:divIndex], lineText[divIndex:] + + displayQueue = [(keyword, drawFormat | curses.A_BOLD), (value, drawFormat)] + cursorLoc = xOffset + + while displayQueue: + msg, format = displayQueue.pop(0) + if not msg: continue + + maxMsgSize = popup.maxX - 1 - cursorLoc + if len(msg) >= maxMsgSize: + # needs to split up the line + msg, remainder = uiTools.cropStr(msg, maxMsgSize, None, endType = None, getRemainder = True) + + if xOffset == cursorLoc and msg == "": + # first word is longer than the line + msg = uiTools.cropStr(remainder, maxMsgSize) + + if " " in remainder: + remainder = remainder.split(" ", 1)[1] + else: remainder = "" + + popup.addstr(drawLine, cursorLoc, msg, format) + cursorLoc = xOffset + + if remainder: + displayQueue.insert(0, (remainder.strip(), format)) + drawLine += 1 + else: + popup.addstr(drawLine, cursorLoc, msg, format) + cursorLoc += len(msg) + + if drawLine > pageHeight: break + + drawLine += 1 + if drawLine > pageHeight: break + + popup.win.refresh() + diff --git a/src/cli/descriptorPopup.py b/src/cli/descriptorPopup.py deleted file mode 100644 index 5b9f646..0000000 --- a/src/cli/descriptorPopup.py +++ /dev/null @@ -1,216 +0,0 @@ -#!/usr/bin/env python -# descriptorPopup.py -- popup panel used to show raw consensus data -# Released under the GPL v3 (http://www.gnu.org/licenses/gpl.html) - -import math -import curses - -import controller -import connections.connEntry -import popups -from util import panel, torTools, uiTools - -# field keywords used to identify areas for coloring -LINE_NUM_COLOR = "yellow" -HEADER_COLOR = "cyan" -HEADER_PREFIX = ["ns/id/", "desc/id/"] - -SIG_COLOR = "red" -SIG_START_KEYS = ["-----BEGIN RSA PUBLIC KEY-----", "-----BEGIN SIGNATURE-----"] -SIG_END_KEYS = ["-----END RSA PUBLIC KEY-----", "-----END SIGNATURE-----"] - -UNRESOLVED_MSG = "No consensus data available" -ERROR_MSG = "Unable to retrieve data" - -def addstr_wrap(panel, y, x, text, formatting, startX = 0, endX = -1, maxY = -1): - """ - Writes text with word wrapping, returning the ending y/x coordinate. - y: starting write line - x: column offset from startX - text / formatting: content to be written - startX / endX: column bounds in which text may be written - """ - - # moved out of panel (trying not to polute new code!) - # TODO: unpleaseantly complex usage - replace with something else when - # rewriting confPanel and descriptorPopup (the only places this is used) - if not text: return (y, x) # nothing to write - if endX == -1: endX = panel.maxX # defaults to writing to end of panel - if maxY == -1: maxY = panel.maxY + 1 # defaults to writing to bottom of panel - lineWidth = endX - startX # room for text - while True: - if len(text) > lineWidth - x - 1: - chunkSize = text.rfind(" ", 0, lineWidth - x) - writeText = text[:chunkSize] - text = text[chunkSize:].strip() - - panel.addstr(y, x + startX, writeText, formatting) - y, x = y + 1, 0 - if y >= maxY: return (y, x) - else: - panel.addstr(y, x + startX, text, formatting) - return (y, x + len(text)) - -class PopupProperties: - """ - State attributes of popup window for consensus descriptions. - """ - - def __init__(self): - self.fingerprint = "" - self.entryColor = "white" - self.text = [] - self.scroll = 0 - self.showLineNum = True - - def reset(self, fingerprint, entryColor): - self.fingerprint = fingerprint - self.entryColor = entryColor - self.text = [] - self.scroll = 0 - - if fingerprint == "UNKNOWN": - self.fingerprint = None - self.showLineNum = False - self.text.append(UNRESOLVED_MSG) - else: - conn = torTools.getConn() - self.showLineNum = True - - self.text.append("ns/id/%s" % fingerprint) - consensusEntry = conn.getConsensusEntry(fingerprint) - - if consensusEntry: self.text += consensusEntry.split("\n") - else: self.text = self.text + [ERROR_MSG, ""] - - self.text.append("desc/id/%s" % fingerprint) - descriptorEntry = conn.getDescriptorEntry(fingerprint) - - if descriptorEntry: self.text += descriptorEntry.split("\n") - else: self.text = self.text + [ERROR_MSG] - - def handleKey(self, key, height): - if key == curses.KEY_UP: self.scroll = max(self.scroll - 1, 0) - elif key == curses.KEY_DOWN: self.scroll = max(0, min(self.scroll + 1, len(self.text) - height)) - elif key == curses.KEY_PPAGE: self.scroll = max(self.scroll - height, 0) - elif key == curses.KEY_NPAGE: self.scroll = max(0, min(self.scroll + height, len(self.text) - height)) - -def showDescriptorPopup(connectionPanel): - """ - Presents consensus descriptor in popup window with the following controls: - Up, Down, Page Up, Page Down - scroll descriptor - Right, Left - next / previous connection - Enter, Space, d, D - close popup - """ - - # hides the title of the first panel on the page - control = controller.getController() - topPanel = control.getDisplayPanels(includeSticky = False)[0] - topPanel.setTitleVisible(False) - topPanel.redraw(True) - - properties = PopupProperties() - isVisible = True - - panel.CURSES_LOCK.acquire() - - try: - while isVisible: - selection = connectionPanel._scroller.getCursorSelection(connectionPanel._entryLines) - if not selection: break - fingerprint = selection.foreign.getFingerprint() - entryColor = connections.connEntry.CATEGORY_COLOR[selection.getType()] - properties.reset(fingerprint, entryColor) - - # constrains popup size to match text - width, height = 0, 0 - for line in properties.text: - # width includes content, line number field, and border - lineWidth = len(line) + 5 - if properties.showLineNum: lineWidth += int(math.log10(len(properties.text))) + 1 - width = max(width, lineWidth) - - # tracks number of extra lines that will be taken due to text wrap - height += (lineWidth - 2) / connectionPanel.maxX - - while isVisible: - popupHeight = min(len(properties.text) + height + 2, connectionPanel.maxY) - popup, _, _ = popups.init(popupHeight, width) - if not popup: break - - try: - draw(popup, properties) - key = control.getScreen().getch() - - if uiTools.isSelectionKey(key) or key in (ord('d'), ord('D')): - # closes popup - isVisible = False - elif key in (curses.KEY_LEFT, curses.KEY_RIGHT): - # navigation - pass on to connPanel and recreate popup - connectionPanel.handleKey(curses.KEY_UP if key == curses.KEY_LEFT else curses.KEY_DOWN) - break - else: properties.handleKey(key, popup.height - 2) - finally: popups.finalize() - finally: panel.CURSES_LOCK.release() - - topPanel.setTitleVisible(True) - -def draw(popup, properties): - popup.win.erase() - popup.win.box() - xOffset = 2 - - if properties.text: - if properties.fingerprint: popup.addstr(0, 0, "Consensus Descriptor (%s):" % properties.fingerprint, curses.A_STANDOUT) - else: popup.addstr(0, 0, "Consensus Descriptor:", curses.A_STANDOUT) - - isEncryption = False # true if line is part of an encryption block - - # checks if first line is in an encryption block - for i in range(0, properties.scroll): - lineText = properties.text[i].strip() - if lineText in SIG_START_KEYS: isEncryption = True - elif lineText in SIG_END_KEYS: isEncryption = False - - pageHeight = popup.maxY - 2 - numFieldWidth = int(math.log10(len(properties.text))) + 1 - lineNum = 1 - for i in range(properties.scroll, min(len(properties.text), properties.scroll + pageHeight)): - lineText = properties.text[i].strip() - - numOffset = 0 # offset for line numbering - if properties.showLineNum: - popup.addstr(lineNum, xOffset, ("%%%ii" % numFieldWidth) % (i + 1), curses.A_BOLD | uiTools.getColor(LINE_NUM_COLOR)) - numOffset = numFieldWidth + 1 - - if lineText: - keyword = lineText.split()[0] # first word of line - remainder = lineText[len(keyword):] - keywordFormat = curses.A_BOLD | uiTools.getColor(properties.entryColor) - remainderFormat = uiTools.getColor(properties.entryColor) - - if lineText.startswith(HEADER_PREFIX[0]) or lineText.startswith(HEADER_PREFIX[1]): - keyword, remainder = lineText, "" - keywordFormat = curses.A_BOLD | uiTools.getColor(HEADER_COLOR) - if lineText == UNRESOLVED_MSG or lineText == ERROR_MSG: - keyword, remainder = lineText, "" - if lineText in SIG_START_KEYS: - keyword, remainder = lineText, "" - isEncryption = True - keywordFormat = curses.A_BOLD | uiTools.getColor(SIG_COLOR) - elif lineText in SIG_END_KEYS: - keyword, remainder = lineText, "" - isEncryption = False - keywordFormat = curses.A_BOLD | uiTools.getColor(SIG_COLOR) - elif isEncryption: - keyword, remainder = lineText, "" - keywordFormat = uiTools.getColor(SIG_COLOR) - - lineNum, xLoc = addstr_wrap(popup, lineNum, 0, keyword, keywordFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) - lineNum, xLoc = addstr_wrap(popup, lineNum, xLoc, remainder, remainderFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) - - lineNum += 1 - if lineNum > pageHeight: break - - popup.win.refresh() - diff --git a/src/util/panel.py b/src/util/panel.py index 8a95479..0e84005 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -677,6 +677,8 @@ class Panel(): for i in range(scrollbarHeight): if i >= sliderTop and i <= sliderTop + sliderSize: self.addstr(i + drawTop, drawLeft, " ", curses.A_STANDOUT) + else: + self.addstr(i + drawTop, drawLeft, " ") # draws box around the scroll bar self.vline(drawTop, drawLeft + 1, drawBottom - 1)

1 0

[arm/release] fix: failing fingerprint lookups when DirPort
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 05b308a560ba4f0ff047db42939dc7b69c58b547 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 13 15:21:08 2011 -0700 fix: failing fingerprint lookups when DirPort Inbound and outbound connection types were assuming that the ports they were connected to was a relay's ORPort and using this to narrow results in fingerprint lookups. However, we could be attached to a relay's DirPort in which case the lookup failed (but when pressing enter there was only a single possible relay result). Instead only using the port to narrow the results when there's multiple matches. --- src/cli/connections/connEntry.py | 19 ++++++++++++------- 1 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/cli/connections/connEntry.py b/src/cli/connections/connEntry.py index 0c82495..075dfb2 100644 --- a/src/cli/connections/connEntry.py +++ b/src/cli/connections/connEntry.py @@ -55,9 +55,10 @@ class Endpoint: self.ipAddr = ipAddr self.port = port - # if true, we treat the port as an ORPort when searching for matching - # fingerprints (otherwise the ORPort is assumed to be unknown) - self.isORPort = False + # if true, we treat the port as an definitely not being an ORPort when + # searching for matching fingerprints (otherwise we use it to possably + # narrow results when unknown) + self.isNotORPort = True # if set then this overwrites fingerprint lookups self.fingerprintOverwrite = None @@ -119,8 +120,12 @@ class Endpoint: return self.fingerprintOverwrite conn = torTools.getConn() - orPort = self.port if self.isORPort else None - myFingerprint = conn.getRelayFingerprint(self.ipAddr, orPort) + myFingerprint = conn.getRelayFingerprint(self.ipAddr) + + # If there were multiple matches and our port is likely the ORPort then + # try again with that to narrow the results. + if not myFingerprint and not self.isNotORPort: + myFingerprint = conn.getRelayFingerprint(self.ipAddr, self.port) if myFingerprint: return myFingerprint else: return "UNKNOWN" @@ -226,7 +231,7 @@ class ConnectionLine(entries.ConnectionPanelLine): if lPort in (myOrPort, myDirPort): self.baseType = Category.INBOUND - self.local.isORPort = True + self.local.isNotORPort = False elif lPort == mySocksPort: self.baseType = Category.SOCKS elif fPort in myHiddenServicePorts: @@ -235,7 +240,7 @@ class ConnectionLine(entries.ConnectionPanelLine): self.baseType = Category.CONTROL else: self.baseType = Category.OUTBOUND - self.foreign.isORPort = True + self.foreign.isNotORPort = False self.cachedType = None

1 0

[arm/release] Adding a dialog for showing usage stats
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 4e61f4660c8c5bd5b5fa8a045dd2a39deada65cc Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 17 10:16:13 2011 -0700 Adding a dialog for showing usage stats Dialog is enabled for bridges, guards, and exits to show client locale and exit port usage statistics. --- README | 1 + src/cli/connections/__init__.py | 2 +- src/cli/connections/connPanel.py | 74 ++++++++++++++++++++++++++++++- src/cli/connections/countPopup.py | 86 +++++++++++++++++++++++++++++++++++++ 4 files changed, 159 insertions(+), 4 deletions(-) diff --git a/README b/README index 119d24e..cbaf31a 100644 --- a/README +++ b/README @@ -174,6 +174,7 @@ Layout: connPanel.py - (page 2) lists the active tor connections circEntry.py - circuit entries in the connection panel connEntry.py - individual connections to or from the system + countPopup.py - displays client locale or exit port counts descriptorPopup.py - displays raw descriptor and consensus entries entries.py - common parent for connPanel display entries diff --git a/src/cli/connections/__init__.py b/src/cli/connections/__init__.py index 0f29d23..abd3410 100644 --- a/src/cli/connections/__init__.py +++ b/src/cli/connections/__init__.py @@ -2,5 +2,5 @@ Connection panel related resources. """ -__all__ = ["circEntry", "connEntry", "connPanel", "descriptorPopup", "entries"] +__all__ = ["circEntry", "connEntry", "connPanel", "countPopup", "descriptorPopup", "entries"] diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 923902c..9745176 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -2,13 +2,14 @@ Listing of the currently established connections tor has made. """ +import re import time import curses import threading import cli.popups -from cli.connections import descriptorPopup, entries, connEntry, circEntry +from cli.connections import countPopup, descriptorPopup, entries, connEntry, circEntry from util import connections, enum, panel, torTools, uiTools DEFAULT_CONFIG = {"features.connection.resolveApps": True, @@ -68,6 +69,32 @@ class ConnectionPanel(panel.Panel, threading.Thread): self._cond = threading.Condition() # used for pausing the thread self.valsLock = threading.RLock() + # Tracks exiting port and client country statistics + self._clientLocaleUsage = {} + self._exitPortUsage = {} + + # If we're a bridge and been running over a day then prepopulates with the + # last day's clients. + + conn = torTools.getConn() + bridgeClients = conn.getInfo("status/clients-seen") + + if bridgeClients: + # Response has a couple arguments... + # TimeStarted="2011-08-17 15:50:49" CountrySummary=us=16,de=8,uk=8 + + countrySummary = None + for arg in bridgeClients.split(): + if arg.startswith("CountrySummary="): + countrySummary = arg[15:] + break + + if countrySummary: + for entry in countrySummary.split(","): + if re.match("^..=[0-9]+$", entry): + locale, count = entry.split("=", 1) + self._clientLocaleUsage[locale] = int(count) + # Last sampling received from the ConnectionResolver, used to detect when # it changes. self._lastResourceFetch = -1 @@ -84,7 +111,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): entry.getLines()[0].isInitialConnection = True # listens for when tor stops so we know to stop reflecting changes - torTools.getConn().addStatusListener(self.torStateListener) + conn.addStatusListener(self.torStateListener) def torStateListener(self, conn, eventType): """ @@ -155,6 +182,22 @@ class ConnectionPanel(panel.Panel, threading.Thread): self.valsLock.release() + def isClientsAllowed(self): + """ + True if client connections are permissable, false otherwise. + """ + + conn = torTools.getConn() + return "Guard" in conn.getMyFlags([]) or conn.getOption("BridgeRelay") == "1" + + def isExitsAllowed(self): + """ + True if exit connections are permissable, false otherwise. + """ + + policy = torTools.getConn().getExitPolicy() + return policy and policy.isExitingAllowed() + def showSortDialog(self): """ Provides the sort dialog for our connections. @@ -214,6 +257,10 @@ class ConnectionPanel(panel.Panel, threading.Thread): elif key == ord('d') or key == ord('D'): # presents popup for raw consensus data descriptorPopup.showDescriptorPopup(self) + elif (key == ord('c') or key == ord('C')) and self.isClientsAllowed(): + countPopup.showCountDialog(countPopup.CountType.CLIENT_LOCALE, self._clientLocaleUsage) + elif (key == ord('e') or key == ord('E')) and self.isExitsAllowed(): + countPopup.showCountDialog(countPopup.CountType.EXIT_PORT, self._exitPortUsage) else: isKeystrokeConsumed = False self.valsLock.release() @@ -263,6 +310,13 @@ class ConnectionPanel(panel.Panel, threading.Thread): options.append(("page down", "scroll down a page", None)) options.append(("enter", "edit configuration option", None)) options.append(("d", "raw consensus descriptor", None)) + + if self.isClientsAllowed(): + options.append(("c", "client locale usage summary", None)) + + if self.isExitsAllowed(): + options.append(("e", "exit port usage summary", None)) + options.append(("l", "listed identity", self._listingType.lower())) options.append(("s", "sort ordering", None)) options.append(("u", "resolving utility", resolverUtil)) @@ -411,8 +465,22 @@ class ConnectionPanel(panel.Panel, threading.Thread): # Adds any new connection and circuit entries. for lIp, lPort, fIp, fPort in newConnections: newConnEntry = connEntry.ConnectionEntry(lIp, lPort, fIp, fPort) - if newConnEntry.getLines()[0].getType() != connEntry.Category.CIRCUIT: + newConnLine = newConnEntry.getLines()[0] + + if newConnLine.getType() != connEntry.Category.CIRCUIT: newEntries.append(newConnEntry) + + # updates exit port and client locale usage information + if newConnLine.isPrivate(): + if newConnLine.getType() == connEntry.Category.INBOUND: + # client connection, update locale information + clientLocale = newConnLine.foreign.getLocale() + + if clientLocale: + self._clientLocaleUsage[clientLocale] = self._clientLocaleUsage.get(clientLocale, 0) + 1 + elif newConnLine.getType() == connEntry.Category.EXIT: + exitPort = newConnLine.foreign.getPort() + self._exitPortUsage[exitPort] = self._exitPortUsage.get(exitPort, 0) + 1 for circuitID in newCircuits: status, purpose, path = newCircuits[circuitID] diff --git a/src/cli/connections/countPopup.py b/src/cli/connections/countPopup.py new file mode 100644 index 0000000..341087f --- /dev/null +++ b/src/cli/connections/countPopup.py @@ -0,0 +1,86 @@ +""" +Provides a dialog with client locale or exiting port counts. +""" + +import curses +import operator + +import cli.controller +import cli.popups + +from util import enum, log, uiTools + +CountType = enum.Enum("CLIENT_LOCALE", "EXIT_PORT") + +def showCountDialog(countType, counts): + """ + Provides a dialog with bar graphs and percentages for the given set of + counts. Pressing any key closes the dialog. + + Arguments: + countType - type of counts being presented + counts - mapping of labels to counts + """ + + isNoStats = not counts + noStatsMsg = "Usage stats aren't available yet, press any key..." + + if isNoStats: + popup, width, height = cli.popups.init(3, len(noStatsMsg) + 4) + else: + popup, width, height = cli.popups.init(4 + max(1, len(counts)), 80) + if not popup: return + + try: + control = cli.controller.getController() + + popup.win.box() + + # dialog title + if countType == CountType.CLIENT_LOCALE: + title = "Client Locales" + elif countType == CountType.EXIT_PORT: + title = "Exiting Port Usage" + else: + title = "" + log.log(log.WARN, "Unrecognized count type: %s" % countType) + + popup.addstr(0, 0, title, curses.A_STANDOUT) + + if isNoStats: + popup.addstr(1, 2, noStatsMsg, curses.A_BOLD | uiTools.getColor("cyan")) + else: + sortedCounts = sorted(counts.iteritems(), key=operator.itemgetter(1)) + sortedCounts.reverse() + + # constructs string formatting for the max key and value display width + keyWidth, valWidth, valueTotal = 3, 1, 0 + for k, v in sortedCounts: + keyWidth = max(keyWidth, len(k)) + valWidth = max(valWidth, len(str(v))) + valueTotal += v + + labelFormat = "%%-%is %%%ii (%%%%%%-2i)" % (keyWidth, valWidth) + + for i in range(height - 4): + k, v = sortedCounts[i] + label = labelFormat % (k, v, v * 100 / valueTotal) + popup.addstr(i + 1, 2, label, curses.A_BOLD | uiTools.getColor("green")) + + # All labels have the same size since they're based on the max widths. + # If this changes then this'll need to be the max label width. + labelWidth = len(label) + + # draws simple bar graph for percentages + fillWidth = v * (width - 4 - labelWidth) / valueTotal + for j in range(fillWidth): + popup.addstr(i + 1, 3 + labelWidth + j, " ", curses.A_STANDOUT | uiTools.getColor("red")) + + popup.addstr(height - 2, 2, "Press any key...") + + popup.win.refresh() + + curses.cbreak() + control.getScreen().getch() + finally: cli.popups.finalize() +

1 0