- tor-commits - lists.torproject.org

[arm/release] Moving menus fromt he controller to panels
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit a2c89f6f8261a892cc02aee5325fc0ffff7671d9 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 9 09:56:27 2011 -0700 Moving menus fromt he controller to panels Moving all of the option menus from a huge if/else block in the controller to the panels they're being used for. This included a couple minor changes to the panel api to better accommodate them. --- src/cli/configPanel.py | 15 ++- src/cli/connections/connPanel.py | 39 ++++++- src/cli/controller.py | 242 ++------------------------------------ src/cli/graphing/graphPanel.py | 36 ++++++- src/cli/logPanel.py | 59 +++++++++- src/cli/popups.py | 97 +++++++++++++++- src/cli/torrcPanel.py | 6 +- src/util/panel.py | 27 ++++ 8 files changed, 272 insertions(+), 249 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index 6aaafc2..31a78ab 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -247,6 +247,7 @@ class ConfigPanel(panel.Panel): def handleKey(self, key): self.valsLock.acquire() + isKeystrokeConsumed = True if uiTools.isScrollKey(key): pageHeight = self.getPreferredSize()[0] - 1 detailPanelHeight = self._config["features.config.selectionDetails.height"] @@ -270,8 +271,10 @@ class ConfigPanel(panel.Panel): # converts labels back to enums resultEnums = [getFieldFromLabel(label) for label in results] self.setSortOrder(resultEnums) + else: isKeystrokeConsumed = False self.valsLock.release() + return isKeystrokeConsumed def getHelp(self): options = [] @@ -288,10 +291,6 @@ class ConfigPanel(panel.Panel): def draw(self, width, height): self.valsLock.acquire() - # draws the top label - configType = "Tor" if self.configType == State.TOR else "Arm" - hiddenMsg = "press 'a' to hide most options" if self.showAll else "press 'a' to show all options" - # panel with details for the current selection detailPanelHeight = self._config["features.config.selectionDetails.height"] isScrollbarVisible = False @@ -311,8 +310,12 @@ class ConfigPanel(panel.Panel): self._drawSelectionPanel(cursorSelection, width, detailPanelHeight, isScrollbarVisible) - titleLabel = "%s Configuration (%s):" % (configType, hiddenMsg) - self.addstr(0, 0, titleLabel, curses.A_STANDOUT) + # draws the top label + if self.isTitleVisible(): + configType = "Tor" if self.configType == State.TOR else "Arm" + hiddenMsg = "press 'a' to hide most options" if self.showAll else "press 'a' to show all options" + titleLabel = "%s Configuration (%s):" % (configType, hiddenMsg) + self.addstr(0, 0, titleLabel, curses.A_STANDOUT) # draws left-hand scroll bar if content's longer than the height scrollOffset = 1 diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 8ad41d5..4d89d5c 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -131,6 +131,8 @@ class ConnectionPanel(panel.Panel, threading.Thread): listingType - Listing instance for the primary information to be shown """ + if self._listingType == listingType: return + self.valsLock.acquire() self._listingType = listingType @@ -143,6 +145,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): def handleKey(self, key): self.valsLock.acquire() + isKeystrokeConsumed = True if uiTools.isScrollKey(key): pageHeight = self.getPreferredSize()[0] - 1 if self._showDetails: pageHeight -= (DETAILS_HEIGHT + 1) @@ -159,8 +162,39 @@ class ConnectionPanel(panel.Panel, threading.Thread): optionColors = dict([(attr, entries.SORT_COLORS[attr]) for attr in options]) results = cli.popups.showSortDialog(titleLabel, options, oldSelection, optionColors) if results: self.setSortOrder(results) + elif key == ord('u') or key == ord('U'): + # provides a menu to pick the connection resolver + title = "Resolver Util:" + options = ["auto"] + connections.Resolver.values() + connResolver = connections.getResolver("tor") + + currentOverwrite = connResolver.overwriteResolver + if currentOverwrite == None: oldSelection = 0 + else: oldSelection = options.index(currentOverwrite) + + selection = cli.popups.showMenu(title, options, oldSelection) + + # applies new setting + if selection != -1: + selectedOption = options[selection] if selection != 0 else None + connResolver.overwriteResolver = selectedOption + elif key == ord('l') or key == ord('L'): + # provides a menu to pick the primary information we list connections by + title = "List By:" + options = entries.ListingType.values() + + # dropping the HOSTNAME listing type until we support displaying that content + options.remove(cli.connections.entries.ListingType.HOSTNAME) + + oldSelection = options.index(self._listingType) + selection = cli.popups.showMenu(title, options, oldSelection) + + # applies new setting + if selection != -1: self.setListingType(options[selection]) + else: isKeystrokeConsumed = False self.valsLock.release() + return isKeystrokeConsumed def run(self): """ @@ -233,8 +267,9 @@ class ConnectionPanel(panel.Panel, threading.Thread): drawEntries[i].render(self, 1 + i, 2) # title label with connection counts - title = "Connection Details:" if self._showDetails else self._title - self.addstr(0, 0, title, curses.A_STANDOUT) + if self.isTitleVisible(): + title = "Connection Details:" if self._showDetails else self._title + self.addstr(0, 0, title, curses.A_STANDOUT) scrollOffset = 1 if isScrollbarVisible: diff --git a/src/cli/controller.py b/src/cli/controller.py index a195c15..6f4b70d 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -42,6 +42,7 @@ def refresh(): # new panel params and accessors (this is part of the new controller apis) PANELS = {} STDSCR = None +IS_PAUSED = False def getScreen(): return STDSCR @@ -83,7 +84,6 @@ def getPanels(page = None): CONFIRM_QUIT = True REFRESH_RATE = 5 # seconds between redrawing screen -MAX_REGEX_FILTERS = 5 # maximum number of previous regex filters that'll be remembered # enums for message in control label CTL_HELP, CTL_PAUSED = range(2) @@ -129,6 +129,9 @@ class ControlPanel(panel.Panel): self.msgText = msgText self.msgAttr = msgAttr + def revertMsg(self): + self.setMsg(CTL_PAUSED if IS_PAUSED else CTL_HELP) + def draw(self, width, height): msgText = self.msgText msgAttr = self.msgAttr @@ -275,57 +278,6 @@ def setPauseState(panels, monitorIsPaused, currentPage, overwrite=False): for key in allPanels: panels[key].setPaused(overwrite or monitorIsPaused or (key not in PAGES[currentPage] and key not in PAGE_S)) -def showMenu(stdscr, popup, title, options, initialSelection): - """ - Provides menu with options laid out in a single column. User can cancel - selection with the escape key, in which case this proives -1. Otherwise this - returns the index of the selection. If initialSelection is -1 then the first - option is used and the carrot indicating past selection is ommitted. - """ - - selection = initialSelection if initialSelection != -1 else 0 - - if popup.win: - if not panel.CURSES_LOCK.acquire(False): return -1 - try: - # TODO: should pause interface (to avoid event accumilation) - curses.cbreak() # wait indefinitely for key presses (no timeout) - - # uses smaller dimentions more fitting for small content - popup.height = len(options) + 2 - - newWidth = max([len(label) for label in options]) + 9 - popup.recreate(stdscr, newWidth) - - key = 0 - while not uiTools.isSelectionKey(key): - popup.clear() - popup.win.box() - popup.addstr(0, 0, title, curses.A_STANDOUT) - - for i in range(len(options)): - label = options[i] - format = curses.A_STANDOUT if i == selection else curses.A_NORMAL - tab = "> " if i == initialSelection else " " - popup.addstr(i + 1, 2, tab) - popup.addstr(i + 1, 4, " %s " % label, format) - - popup.refresh() - key = stdscr.getch() - if key == curses.KEY_UP: selection = max(0, selection - 1) - elif key == curses.KEY_DOWN: selection = min(len(options) - 1, selection + 1) - elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel - - # reverts popup dimensions and conn panel label - popup.height = 9 - popup.recreate(stdscr, 80) - - curses.halfdelay(REFRESH_RATE * 10) # reset normal pausing behavior - finally: - panel.CURSES_LOCK.release() - - return selection - def setEventListening(selectedEvents, isBlindMode): # creates a local copy, note that a suspected python bug causes *very* # puzzling results otherwise when trying to discard entries (silently @@ -381,7 +333,7 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): otherwise unrecognized events) """ - global PANELS, STDSCR, REFRESH_FLAG, PAGE + global PANELS, STDSCR, REFRESH_FLAG, PAGE, IS_PAUSED STDSCR = stdscr # loads config for various interface components @@ -592,7 +544,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): isPaused = False # if true updates are frozen overrideKey = None # immediately runs with this input rather than waiting for the user if set page = 0 - regexFilters = [] # previously used log regex filters panels["popup"].redraw(True) # hack to make sure popup has a window instance (not entirely sure why...) PAGE = page @@ -846,6 +797,7 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panel.CURSES_LOCK.acquire() try: isPaused = not isPaused + IS_PAUSED = isPaused setPauseState(panels, isPaused, page) panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) finally: @@ -883,69 +835,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panel.CURSES_LOCK.release() elif key == ord('h') or key == ord('H'): overrideKey = popups.showHelpPopup() - elif page == 0 and (key == ord('s') or key == ord('S')): - # provides menu to pick stats to be graphed - #options = ["None"] + [label for label in panels["graph"].stats.keys()] - options = ["None"] - - # appends stats labels with first letters of each word capitalized - initialSelection, i = -1, 1 - if not panels["graph"].currentDisplay: initialSelection = 0 - graphLabels = panels["graph"].stats.keys() - graphLabels.sort() - for label in graphLabels: - if label == panels["graph"].currentDisplay: initialSelection = i - words = label.split() - options.append(" ".join(word[0].upper() + word[1:] for word in words)) - i += 1 - - # hides top label of the graph panel and pauses panels - if panels["graph"].currentDisplay: - panels["graph"].showLabel = False - panels["graph"].redraw(True) - setPauseState(panels, isPaused, page, True) - - selection = showMenu(stdscr, panels["popup"], "Graphed Stats:", options, initialSelection) - - # reverts changes made for popup - panels["graph"].showLabel = True - setPauseState(panels, isPaused, page) - - # applies new setting - if selection != -1 and selection != initialSelection: - if selection == 0: panels["graph"].setStats(None) - else: panels["graph"].setStats(options[selection].lower()) - - selectiveRefresh(panels, page) - - # TODO: this shouldn't be necessary with the above refresh, but doesn't seem responsive otherwise... - panels["graph"].redraw(True) - elif page == 0 and (key == ord('i') or key == ord('I')): - # provides menu to pick graph panel update interval - options = [label for (label, intervalTime) in graphing.graphPanel.UPDATE_INTERVALS] - - initialSelection = panels["graph"].updateInterval - - #initialSelection = -1 - #for i in range(len(options)): - # if options[i] == panels["graph"].updateInterval: initialSelection = i - - # hides top label of the graph panel and pauses panels - if panels["graph"].currentDisplay: - panels["graph"].showLabel = False - panels["graph"].redraw(True) - setPauseState(panels, isPaused, page, True) - - selection = showMenu(stdscr, panels["popup"], "Update Interval:", options, initialSelection) - - # reverts changes made for popup - panels["graph"].showLabel = True - setPauseState(panels, isPaused, page) - - # applies new setting - if selection != -1: panels["graph"].updateInterval = selection - - selectiveRefresh(panels, page) elif page == 0 and (key == ord('b') or key == ord('B')): # uses the next boundary type for graph panels["graph"].bounds = graphing.graphPanel.Bounds.next(panels["graph"].bounds) @@ -1031,64 +920,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panel.CURSES_LOCK.release() panels["graph"].redraw(True) - elif page == 0 and (key == ord('f') or key == ord('F')): - # provides menu to pick previous regular expression filters or to add a new one - # for syntax see: http://docs.python.org/library/re.html#regular-expression-syntax - options = ["None"] + regexFilters + ["New..."] - initialSelection = 0 if not panels["log"].regexFilter else 1 - - # hides top label of the graph panel and pauses panels - if panels["graph"].currentDisplay: - panels["graph"].showLabel = False - panels["graph"].redraw(True) - setPauseState(panels, isPaused, page, True) - - selection = showMenu(stdscr, panels["popup"], "Log Filter:", options, initialSelection) - - # applies new setting - if selection == 0: - panels["log"].setFilter(None) - elif selection == len(options) - 1: - # selected 'New...' option - prompt user to input regular expression - panel.CURSES_LOCK.acquire() - try: - # provides prompt - panels["control"].setMsg("Regular expression: ") - panels["control"].redraw(True) - - # gets user input (this blocks monitor updates) - regexInput = panels["control"].getstr(0, 20) - - if regexInput: - try: - panels["log"].setFilter(re.compile(regexInput)) - if regexInput in regexFilters: regexFilters.remove(regexInput) - regexFilters = [regexInput] + regexFilters - except re.error, exc: - panels["control"].setMsg("Unable to compile expression: %s" % str(exc), curses.A_STANDOUT) - panels["control"].redraw(True) - time.sleep(2) - panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) - finally: - panel.CURSES_LOCK.release() - elif selection != -1: - try: - panels["log"].setFilter(re.compile(regexFilters[selection - 1])) - - # move selection to top - regexFilters = [regexFilters[selection - 1]] + regexFilters - del regexFilters[selection] - except re.error, exc: - # shouldn't happen since we've already checked validity - log.log(log.WARN, "Invalid regular expression ('%s': %s) - removing from listing" % (regexFilters[selection - 1], str(exc))) - del regexFilters[selection - 1] - - if len(regexFilters) > MAX_REGEX_FILTERS: del regexFilters[MAX_REGEX_FILTERS:] - - # reverts changes made for popup - panels["graph"].showLabel = True - setPauseState(panels, isPaused, page) - panels["graph"].redraw(True) elif page == 0 and key in (ord('n'), ord('N'), ord('m'), ord('M')): # Unfortunately modifier keys don't work with the up/down arrows (sending # multiple keycodes. The only exception to this is shift + left/right, @@ -1124,30 +955,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): setPauseState(panels, isPaused, page) finally: panel.CURSES_LOCK.release() - elif page == 1 and (key == ord('u') or key == ord('U')): - # provides menu to pick identification resolving utility - options = ["auto"] + connections.Resolver.values() - - currentOverwrite = connections.getResolver("tor").overwriteResolver # enums correspond to indices - if currentOverwrite == None: initialSelection = 0 - else: initialSelection = options.index(currentOverwrite) - - # hides top label of conn panel and pauses panels - panelTitle = panels["conn"]._title - panels["conn"]._title = "" - panels["conn"].redraw(True) - setPauseState(panels, isPaused, page, True) - - selection = showMenu(stdscr, panels["popup"], "Resolver Util:", options, initialSelection) - selectedOption = options[selection] if selection != 0 else None - - # reverts changes made for popup - panels["conn"]._title = panelTitle - setPauseState(panels, isPaused, page) - - # applies new setting - if selection != -1 and selectedOption != connections.getResolver("tor").overwriteResolver: - connections.getResolver("tor").overwriteResolver = selectedOption elif page == 1 and key in (ord('d'), ord('D')): # presents popup for raw consensus data panel.CURSES_LOCK.acquire() @@ -1165,31 +972,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): curses.halfdelay(REFRESH_RATE * 10) # reset normal pausing behavior finally: panel.CURSES_LOCK.release() - elif page == 1 and (key == ord('l') or key == ord('L')): - # provides a menu to pick the primary information we list connections by - options = cli.connections.entries.ListingType.values() - - # dropping the HOSTNAME listing type until we support displaying that content - options.remove(cli.connections.entries.ListingType.HOSTNAME) - - initialSelection = options.index(panels["conn"]._listingType) - - # hides top label of connection panel and pauses the display - panelTitle = panels["conn"]._title - panels["conn"]._title = "" - panels["conn"].redraw(True) - setPauseState(panels, isPaused, page, True) - - selection = showMenu(stdscr, panels["popup"], "List By:", options, initialSelection) - - # reverts changes made for popup - panels["conn"]._title = panelTitle - setPauseState(panels, isPaused, page) - - # applies new setting - if selection != -1 and options[selection] != panels["conn"]._listingType: - panels["conn"].setListingType(options[selection]) - panels["conn"].redraw(True) elif page == 2 and (key == ord('w') or key == ord('W')): # display a popup for saving the current configuration panel.CURSES_LOCK.acquire() @@ -1400,14 +1182,10 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): time.sleep(1) panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) - elif page == 0: - panels["log"].handleKey(key) - elif page == 1: - panels["conn"].handleKey(key) - elif page == 2: - panels["config"].handleKey(key) - elif page == 3: - panels["torrc"].handleKey(key) + else: + for pagePanel in getPanels(page + 1): + isKeystrokeConsumed = pagePanel.handleKey(key) + if isKeystrokeConsumed: break if REFRESH_FLAG: REFRESH_FLAG = False diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py index d8808b3..0c52f6f 100644 --- a/src/cli/graphing/graphPanel.py +++ b/src/cli/graphing/graphPanel.py @@ -20,6 +20,8 @@ import copy import curses from TorCtl import TorCtl +import cli.popups + from util import enum, panel, uiTools # time intervals at which graphs can be updated @@ -229,7 +231,6 @@ class GraphPanel(panel.Panel): self.graphHeight = CONFIG["features.graph.height"] self.currentDisplay = None # label of the stats currently being displayed self.stats = {} # available stats (mappings of label -> instance) - self.showLabel = True # shows top label if true, hides otherwise self.setPauseAttr("stats") def getHeight(self): @@ -253,6 +254,37 @@ class GraphPanel(panel.Panel): self.graphHeight = max(MIN_GRAPH_HEIGHT, newGraphHeight) + def handleKey(self, key): + isKeystrokeConsumed = True + if key == ord('s') or key == ord('S'): + # provides a menu to pick the graphed stats + availableStats = self.stats.keys() + availableStats.sort() + + # uses sorted, camel cased labels for the options + options = ["None"] + for label in availableStats: + words = label.split() + options.append(" ".join(word[0].upper() + word[1:] for word in words)) + + if self.currentDisplay: + initialSelection = availableStats.index(self.currentDisplay) + 1 + else: initialSelection = 0 + + selection = cli.popups.showMenu("Graphed Stats:", options, initialSelection) + + # applies new setting + if selection == 0: self.setStats(None) + elif selection != -1: self.setStats(options[selection].lower()) + elif key == ord('i') or key == ord('I'): + # provides menu to pick graph panel update interval + options = [label for (label, _) in UPDATE_INTERVALS] + selection = cli.popups.showMenu("Update Interval:", options, self.updateInterval) + if selection != -1: self.updateInterval = selection + else: isKeystrokeConsumed = False + + return isKeystrokeConsumed + def getHelp(self): if self.currentDisplay: graphedStats = self.currentDisplay else: graphedStats = "none" @@ -275,7 +307,7 @@ class GraphPanel(panel.Panel): primaryColor = uiTools.getColor(param.getColor(True)) secondaryColor = uiTools.getColor(param.getColor(False)) - if self.showLabel: self.addstr(0, 0, param.getTitle(width), curses.A_STANDOUT) + if self.isTitleVisible(): self.addstr(0, 0, param.getTitle(width), curses.A_STANDOUT) # top labels left, right = param.getHeaderLabel(width / 2, True), param.getHeaderLabel(width / 2, False) diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index b12715e..d34b640 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -4,13 +4,15 @@ for. This provides prepopulation from the log file and supports filtering by regular expressions. """ -import time +import re import os +import time import curses import threading from TorCtl import TorCtl +import popups from version import VERSION from util import conf, log, panel, sysTools, torTools, uiTools @@ -75,6 +77,9 @@ CACHED_DUPLICATES_RESULT = None # duration we'll wait for the deduplication function before giving up (in ms) DEDUPLICATION_TIMEOUT = 100 +# maximum number of regex filters we'll remember +MAX_REGEX_FILTERS = 5 + def daysSince(timestamp=None): """ Provides the number of days since the epoch converted to local time (rounded @@ -551,6 +556,7 @@ class LogPanel(panel.Panel, threading.Thread): self.msgLog = [] # log entries, sorted by the timestamp self.loggedEvents = loggedEvents # events we're listening to self.regexFilter = None # filter for presented log events (no filtering if None) + self.filterOptions = [] # filters the user has input self.lastContentHeight = 0 # height of the rendered content when last drawn self.logFile = None # file log messages are saved to (skipped if None) self.scroll = 0 @@ -746,6 +752,7 @@ class LogPanel(panel.Panel, threading.Thread): raise exc def handleKey(self, key): + isKeystrokeConsumed = True if uiTools.isScrollKey(key): pageHeight = self.getPreferredSize()[0] - 1 newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, self.lastContentHeight) @@ -760,6 +767,53 @@ class LogPanel(panel.Panel, threading.Thread): self.showDuplicates = not self.showDuplicates self.redraw(True) self.valsLock.release() + elif key == ord('f') or key == ord('F'): + # Provides menu to pick regular expression filters or adding new ones: + # for syntax see: http://docs.python.org/library/re.html#regular-expression-syntax + options = ["None"] + self.filterOptions + ["New..."] + oldSelection = 0 if not self.regexFilter else 1 + + # does all activity under a curses lock to prevent redraws when adding + # new filters + panel.CURSES_LOCK.acquire() + try: + selection = popups.showMenu("Log Filter:", options, oldSelection) + + # applies new setting + if selection == 0: + self.setFilter(None) + elif selection == len(options) - 1: + # selected 'New...' option - prompt user to input regular expression + regexInput = popups.inputPrompt("Regular expression: ") + + if regexInput: + try: + self.setFilter(re.compile(regexInput)) + if regexInput in self.filterOptions: self.filterOptions.remove(regexInput) + self.filterOptions.insert(0, regexInput) + except re.error, exc: + popups.showMsg("Unable to compile expression: %s" % exc, 2) + elif selection != -1: + selectedOption = self.filterOptions[selection - 1] + + try: + self.setFilter(re.compile(selectedOption)) + + # move selection to top + self.filterOptions.remove(selectedOption) + self.filterOptions.insert(0, selectedOption) + except re.error, exc: + # shouldn't happen since we've already checked validity + msg = "Invalid regular expression ('%s': %s) - removing from listing" % (selectedOption, exc) + log.log(log.WARN, msg) + self.filterOptions.remove(selectedOption) + finally: + panel.CURSES_LOCK.release() + + if len(self.filterOptions) > MAX_REGEX_FILTERS: del self.filterOptions[MAX_REGEX_FILTERS:] + else: isKeystrokeConsumed = False + + return isKeystrokeConsumed def getHelp(self): options = [] @@ -784,7 +838,8 @@ class LogPanel(panel.Panel, threading.Thread): self._lastLoggedEvents, self._lastUpdate = list(currentLog), time.time() # draws the top label - self.addstr(0, 0, self._getTitle(width), curses.A_STANDOUT) + if self.isTitleVisible(): + self.addstr(0, 0, self._getTitle(width), curses.A_STANDOUT) # restricts scroll location to valid bounds self.scroll = max(0, min(self.scroll, self.lastContentHeight - height + 1)) diff --git a/src/cli/popups.py b/src/cli/popups.py index d5cf76c..81b4589 100644 --- a/src/cli/popups.py +++ b/src/cli/popups.py @@ -44,6 +44,46 @@ def finalize(): controller.refresh() panel.CURSES_LOCK.release() +def inputPrompt(msg): + """ + Prompts the user to enter a string on the control line (which usually + displays the page number and basic controls). + + Arguments: + msg - message to prompt the user for input with + """ + + panel.CURSES_LOCK.acquire() + controlPanel = controller.getPanel("control") + controlPanel.setMsg(msg) + controlPanel.redraw(True) + userInput = controlPanel.getstr(0, len(msg)) + controlPanel.revertMsg() + panel.CURSES_LOCK.release() + return userInput + +def showMsg(msg, maxWait, attr = curses.A_STANDOUT): + """ + Displays a single line message on the control line for a set time. Pressing + any key will end the message. + + Arguments: + msg - message to be displayed to the user + maxWait - time to show the message + attr - attributes with which to draw the message + """ + + panel.CURSES_LOCK.acquire() + controlPanel = controller.getPanel("control") + controlPanel.setMsg(msg, attr) + controlPanel.redraw(True) + + curses.halfdelay(maxWait * 10) + controller.getScreen().getch() + controlPanel.revertMsg() + curses.halfdelay(controller.REFRESH_RATE * 10) + panel.CURSES_LOCK.release() + def showHelpPopup(): """ Presents a popup with instructions for the current page's hotkeys. This @@ -108,7 +148,7 @@ def showHelpPopup(): return exitKey else: return None -def showSortDialog(titleLabel, options, oldSelection, optionColors): +def showSortDialog(title, options, oldSelection, optionColors): """ Displays a sorting dialog of the form: @@ -122,7 +162,7 @@ def showSortDialog(titleLabel, options, oldSelection, optionColors): then this returns None. Otherwise, the new ordering is provided. Arguments: - titleLabel - title displayed for the popup window + title - title displayed for the popup window options - ordered listing of option labels oldSelection - current ordering optionColors - mappings of options to their color @@ -142,7 +182,7 @@ def showSortDialog(titleLabel, options, oldSelection, optionColors): while len(newSelections) < len(oldSelection): popup.win.erase() popup.win.box() - popup.addstr(0, 0, titleLabel, curses.A_STANDOUT) + popup.addstr(0, 0, title, curses.A_STANDOUT) _drawSortSelection(popup, 1, 2, "Current Order: ", oldSelection, optionColors) _drawSortSelection(popup, 2, 2, "New Order: ", newSelections, optionColors) @@ -214,3 +254,54 @@ def _drawSortSelection(popup, y, x, prefix, options, optionColors): popup.addstr(y, x, ", ", curses.A_BOLD) x += 2 +def showMenu(title, options, oldSelection): + """ + Provides menu with options laid out in a single column. User can cancel + selection with the escape key, in which case this proives -1. Otherwise this + returns the index of the selection. + + Arguments: + title - title displayed for the popup window + options - ordered listing of options to display + oldSelection - index of the initially selected option (uses the first + selection without a carrot if -1) + """ + + maxWidth = max([len(label) for label in options]) + 9 + popup, width, height = init(len(options) + 2, maxWidth) + if not popup: return + key, selection = 0, oldSelection if oldSelection != -1 else 0 + + try: + # hides the title of the first panel on the page + topPanel = controller.getPanels(controller.getPage())[0] + topPanel.setTitleVisible(False) + topPanel.redraw(True) + + curses.cbreak() # wait indefinitely for key presses (no timeout) + + while not uiTools.isSelectionKey(key): + popup.win.erase() + popup.win.box() + popup.addstr(0, 0, title, curses.A_STANDOUT) + + for i in range(len(options)): + label = options[i] + format = curses.A_STANDOUT if i == selection else curses.A_NORMAL + tab = "> " if i == oldSelection else " " + popup.addstr(i + 1, 2, tab) + popup.addstr(i + 1, 4, " %s " % label, format) + + popup.win.refresh() + + key = controller.getScreen().getch() + if key == curses.KEY_UP: selection = max(0, selection - 1) + elif key == curses.KEY_DOWN: selection = min(len(options) - 1, selection + 1) + elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel + + topPanel.setTitleVisible(True) + curses.halfdelay(controller.REFRESH_RATE * 10) # reset normal pausing behavior + finally: finalize() + + return selection + diff --git a/src/cli/torrcPanel.py b/src/cli/torrcPanel.py index 6d7156d..5ca839f 100644 --- a/src/cli/torrcPanel.py +++ b/src/cli/torrcPanel.py @@ -31,7 +31,6 @@ class TorrcPanel(panel.Panel): self.valsLock = threading.RLock() self.configType = configType self.scroll = 0 - self.showLabel = True # shows top label (hides otherwise) self.showLineNum = True # shows left aligned line numbers self.stripComments = False # drops comments and extra whitespace @@ -42,6 +41,7 @@ class TorrcPanel(panel.Panel): def handleKey(self, key): self.valsLock.acquire() + isKeystrokeConsumed = True if uiTools.isScrollKey(key): pageHeight = self.getPreferredSize()[0] - 1 newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, self._lastContentHeight) @@ -57,8 +57,10 @@ class TorrcPanel(panel.Panel): self.stripComments = not self.stripComments self._lastContentHeightArgs = None self.redraw(True) + else: isKeystrokeConsumed = False self.valsLock.release() + return isKeystrokeConsumed def getHelp(self): options = [] @@ -120,7 +122,7 @@ class TorrcPanel(panel.Panel): displayLine = -self.scroll + 1 # line we're drawing on # draws the top label - if self.showLabel: + if self.isTitleVisible(): sourceLabel = "Tor" if self.configType == Config.TORRC else "Arm" locationLabel = " (%s)" % confLocation if confLocation else "" self.addstr(0, 0, "%s Configuration File%s:" % (sourceLabel, locationLabel), curses.A_STANDOUT) diff --git a/src/util/panel.py b/src/util/panel.py index 7387833..06c8649 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -61,6 +61,7 @@ class Panel(): self.panelName = name self.parent = parent self.visible = False + self.titleVisible = True # Attributes for pausing. The pauseAttr contains variables our getAttr # method is tracking, and the pause buffer has copies of the values from @@ -93,6 +94,21 @@ class Panel(): return self.panelName + def isTitleVisible(self): + """ + True if the title is configured to be visible, False otherwise. + """ + + return self.titleVisible + + def setTitleVisible(self, isVisible): + """ + Configures the panel's title to be visible or not when it's next redrawn. + This is not guarenteed to be respected (not all panels have a title). + """ + + self.titleVisible = isVisible + def getParent(self): """ Provides the parent used to create subwindows. @@ -290,6 +306,17 @@ class Panel(): if setWidth != -1: newWidth = min(newWidth, setWidth) return (newHeight, newWidth) + def handleKey(self, key): + """ + Handler for user input. This returns true if the key press was consumed, + false otherwise. + + Arguments: + key - keycode for the key pressed + """ + + return False + def getHelp(self): """ Provides help information for the controls this page provides. This is a

1 0

[arm/release] Moving help popup into a new popup toolkit
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit b3fd2f2df18ce7310c33006f1d81f10bae620010 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 6 21:00:02 2011 -0700 Moving help popup into a new popup toolkit Breaking the help popup out of the controller, moving it to a nice, modular 'show popup' function. This is a drop-in replacement (besides some reordered help options) and also allowed us to move the help content into their respective panels. This is far cleaner and avoids accessing private panel parameters. Next the rest of the popups will be moved to this new toolkit, which will greatly clean up the controller. --- README | 3 +- src/cli/__init__.py | 2 +- src/cli/configPanel.py | 12 +++ src/cli/connections/connPanel.py | 16 ++++ src/cli/controller.py | 155 ++++++++++++++++---------------------- src/cli/graphing/graphPanel.py | 12 +++ src/cli/logPanel.py | 11 +++ src/cli/popups.py | 110 +++++++++++++++++++++++++++ src/cli/torrcPanel.py | 12 +++ src/util/panel.py | 9 ++ 10 files changed, 250 insertions(+), 92 deletions(-) diff --git a/README b/README index ff03b37..e7c2e2c 100644 --- a/README +++ b/README @@ -157,7 +157,8 @@ Layout: __init__.py controller.py - main display loop, handling input and layout headerPanel.py - top of all pages, providing general information - descriptorPopup.py - (popup) displays connection descriptor data + descriptorPopup.py - displays connection descriptor data + popups.py - toolkit providing display popups logPanel.py - (page 1) displays tor, arm, and torctl events configPanel.py - (page 3) editor panel for the tor configuration diff --git a/src/cli/__init__.py b/src/cli/__init__.py index 171af09..1564f68 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", "torrcPanel"] +__all__ = ["configPanel", "controller", "descriptorPopup", "headerPanel", "logPanel", "popups", "torrcPanel"] diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index fd6fb54..90c6191 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -248,6 +248,18 @@ class ConfigPanel(panel.Panel): self.redraw(True) self.valsLock.release() + def getHelp(self): + options = [] + options.append(("up arrow", "scroll up a line", None)) + options.append(("down arrow", "scroll down a line", None)) + 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(("a", "toggle option filtering", None)) + options.append(("s", "sort ordering", None)) + return options + def draw(self, width, height): self.valsLock.acquire() diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 5f4f036..40c479e 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -185,6 +185,22 @@ class ConnectionPanel(panel.Panel, threading.Thread): drawTicks = (time.time() - lastDraw) / self._config["features.connection.refreshRate"] lastDraw += self._config["features.connection.refreshRate"] * drawTicks + def getHelp(self): + resolverUtil = connections.getResolver("tor").overwriteResolver + if resolverUtil == None: resolverUtil = "auto" + + options = [] + options.append(("up arrow", "scroll up a line", None)) + options.append(("down arrow", "scroll down a line", None)) + 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(("d", "raw consensus descriptor", None)) + options.append(("l", "listed identity", self._listingType.lower())) + options.append(("s", "sort ordering", None)) + options.append(("u", "resolving utility", resolverUtil)) + return options + def draw(self, width, height): self.valsLock.acquire() diff --git a/src/cli/controller.py b/src/cli/controller.py index b8bb5cd..1501419 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -15,6 +15,7 @@ import curses.textpad import socket from TorCtl import TorCtl +import popups import headerPanel import graphing.graphPanel import logPanel @@ -30,6 +31,56 @@ import graphing.bandwidthStats import graphing.connStats import graphing.resourceStats +# TODO: controller should be its own object that can be refreshed - until that +# emulating via a 'refresh' flag +REFRESH_FLAG = False + +def refresh(): + global REFRESH_FLAG + REFRESH_FLAG = True + +# new panel params and accessors (this is part of the new controller apis) +PANELS = {} +STDSCR = None + +def getScreen(): + return STDSCR + +def getPage(): + """ + Provides the number belonging to this page. Page numbers start at one. + """ + + return PAGE + 1 + +def getPanel(name): + """ + Provides the panel with the given identifier. + + Arguments: + name - name of the panel to be fetched + """ + + return PANELS[name] + +def getPanels(page = None): + """ + Provides all panels or all panels from a given page. + + Arguments: + page - page number of the panels to be fetched, all panels if undefined + """ + + panelSet = [] + if page == None: + # fetches all panel names + panelSet = list(PAGE_S) + for pagePanels in PAGES: + panelSet += pagePanels + else: panelSet = PAGES[page - 1] + + return [getPanel(name) for name in panelSet] + CONFIRM_QUIT = True REFRESH_RATE = 5 # seconds between redrawing screen MAX_REGEX_FILTERS = 5 # maximum number of previous regex filters that'll be remembered @@ -422,6 +473,9 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): otherwise unrecognized events) """ + global PANELS, STDSCR, REFRESH_FLAG, PAGE + STDSCR = stdscr + # loads config for various interface components config = conf.getConfig("arm") config.update(CONFIG) @@ -609,6 +663,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): pluralLabel = "s" if len(missingEventTypes) > 1 else "" log.log(CONFIG["log.torEventTypeUnrecognized"], "arm doesn't recognize the following event type%s: %s (log 'UNKNOWN' events to see them)" % (pluralLabel, ", ".join(missingEventTypes))) + PANELS = panels + # tells revised panels to run as daemons panels["header"].start() panels["log"].start() @@ -631,6 +687,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): regexFilters = [] # previously used log regex filters panels["popup"].redraw(True) # hack to make sure popup has a window instance (not entirely sure why...) + PAGE = page + # provides notice about any unused config keys for key in config.getUnusedKeys(): log.log(CONFIG["log.configEntryUndefined"], "Unused configuration entry: %s" % key) @@ -866,6 +924,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): isVisible = i == page for entry in PAGES[i]: panels[entry].setVisible(isVisible) + PAGE = page + panels["control"].page = page + 1 # TODO: this redraw doesn't seem necessary (redraws anyway after this @@ -914,96 +974,7 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): finally: panel.CURSES_LOCK.release() elif key == ord('h') or key == ord('H'): - # displays popup for current page's controls - panel.CURSES_LOCK.acquire() - try: - setPauseState(panels, isPaused, page, True) - - # lists commands - popup = panels["popup"] - popup.clear() - popup.win.box() - popup.addstr(0, 0, "Page %i Commands:" % (page + 1), curses.A_STANDOUT) - - pageOverrideKeys = () - - if page == 0: - graphedStats = panels["graph"].currentDisplay - if not graphedStats: graphedStats = "none" - popup.addfstr(1, 2, "up arrow: scroll log up a line") - popup.addfstr(1, 41, "down arrow: scroll log down a line") - popup.addfstr(2, 2, "m: increase graph size") - popup.addfstr(2, 41, "n: decrease graph size") - popup.addfstr(3, 2, "s: graphed stats (%s)" % graphedStats) - popup.addfstr(3, 41, "i: graph update interval (%s)" % graphing.graphPanel.UPDATE_INTERVALS[panels["graph"].updateInterval][0]) - popup.addfstr(4, 2, "b: graph bounds (%s)" % panels["graph"].bounds.lower()) - popup.addfstr(4, 41, "a: save snapshot of the log") - popup.addfstr(5, 2, "e: change logged events") - - regexLabel = "enabled" if panels["log"].regexFilter else "disabled" - popup.addfstr(5, 41, "f: log regex filter (%s)" % regexLabel) - - hiddenEntryLabel = "visible" if panels["log"].showDuplicates else "hidden" - popup.addfstr(6, 2, "u: duplicate log entries (%s)" % hiddenEntryLabel) - popup.addfstr(6, 41, "c: clear event log") - - pageOverrideKeys = (ord('m'), ord('n'), ord('s'), ord('i'), ord('d'), ord('e'), ord('r'), ord('f'), ord('x')) - if page == 1: - popup.addfstr(1, 2, "up arrow: scroll up a line") - popup.addfstr(1, 41, "down arrow: scroll down a line") - popup.addfstr(2, 2, "page up: scroll up a page") - popup.addfstr(2, 41, "page down: scroll down a page") - - popup.addfstr(3, 2, "enter: edit configuration option") - popup.addfstr(3, 41, "d: raw consensus descriptor") - - listingType = panels["conn"]._listingType.lower() - popup.addfstr(4, 2, "l: listed identity (%s)" % listingType) - - popup.addfstr(4, 41, "s: sort ordering") - - resolverUtil = connections.getResolver("tor").overwriteResolver - if resolverUtil == None: resolverUtil = "auto" - popup.addfstr(5, 2, "u: resolving utility (%s)" % resolverUtil) - - pageOverrideKeys = (ord('d'), ord('l'), ord('s'), ord('u')) - elif page == 2: - popup.addfstr(1, 2, "up arrow: scroll up a line") - popup.addfstr(1, 41, "down arrow: scroll down a line") - popup.addfstr(2, 2, "page up: scroll up a page") - popup.addfstr(2, 41, "page down: scroll down a page") - popup.addfstr(3, 2, "enter: edit configuration option") - popup.addfstr(3, 41, "w: save configuration") - popup.addfstr(4, 2, "a: toggle option filtering") - popup.addfstr(4, 41, "s: sort ordering") - elif page == 3: - popup.addfstr(1, 2, "up arrow: scroll up a line") - popup.addfstr(1, 41, "down arrow: scroll down a line") - popup.addfstr(2, 2, "page up: scroll up a page") - popup.addfstr(2, 41, "page down: scroll down a page") - - strippingLabel = "on" if panels["torrc"].stripComments else "off" - popup.addfstr(3, 2, "s: comment stripping (%s)" % strippingLabel) - - lineNumLabel = "on" if panels["torrc"].showLineNum else "off" - popup.addfstr(3, 41, "n: line numbering (%s)" % lineNumLabel) - - popup.addfstr(4, 2, "r: reload torrc") - popup.addfstr(4, 41, "x: reset tor (issue sighup)") - - popup.addstr(7, 2, "Press any key...") - popup.refresh() - - # waits for user to hit a key, if it belongs to a command then executes it - curses.cbreak() - helpExitKey = stdscr.getch() - if helpExitKey in pageOverrideKeys: overrideKey = helpExitKey - curses.halfdelay(REFRESH_RATE * 10) - - setPauseState(panels, isPaused, page) - selectiveRefresh(panels, page) - finally: - panel.CURSES_LOCK.release() + overrideKey = popups.showHelpPopup() elif page == 0 and (key == ord('s') or key == ord('S')): # provides menu to pick stats to be graphed #options = ["None"] + [label for label in panels["graph"].stats.keys()] @@ -1585,6 +1556,10 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panels["config"].handleKey(key) elif page == 3: panels["torrc"].handleKey(key) + + if REFRESH_FLAG: + REFRESH_FLAG = False + selectiveRefresh(panels, page) def startTorMonitor(startTime, loggedEvents, isBlindMode): try: diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py index 238e163..d8808b3 100644 --- a/src/cli/graphing/graphPanel.py +++ b/src/cli/graphing/graphPanel.py @@ -253,6 +253,18 @@ class GraphPanel(panel.Panel): self.graphHeight = max(MIN_GRAPH_HEIGHT, newGraphHeight) + def getHelp(self): + if self.currentDisplay: graphedStats = self.currentDisplay + else: graphedStats = "none" + + options = [] + options.append(("m", "increase graph size", None)) + options.append(("n", "decrease graph size", None)) + options.append(("s", "graphed stats", graphedStats)) + options.append(("b", "graph bounds", self.bounds.lower())) + options.append(("i", "graph update interval", UPDATE_INTERVALS[self.updateInterval][0])) + return options + def draw(self, width, height): """ Redraws graph panel """ diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index 6feb129..b12715e 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -761,6 +761,17 @@ class LogPanel(panel.Panel, threading.Thread): self.redraw(True) self.valsLock.release() + def getHelp(self): + options = [] + options.append(("up arrow", "scroll log up a line", None)) + options.append(("down arrow", "scroll log down a line", None)) + options.append(("a", "save snapshot of the log", None)) + options.append(("e", "change logged events", None)) + options.append(("f", "log regex filter", "enabled" if self.regexFilter else "disabled")) + options.append(("u", "duplicate log entries", "visible" if self.showDuplicates else "hidden")) + options.append(("c", "clear event log", None)) + return options + def draw(self, width, height): """ Redraws message log. Entries stretch to use available space and may diff --git a/src/cli/popups.py b/src/cli/popups.py new file mode 100644 index 0000000..ce51ee8 --- /dev/null +++ b/src/cli/popups.py @@ -0,0 +1,110 @@ +""" +Functions for displaying popups in the interface. +""" + +import curses + +import controller + +from util import panel, uiTools + +def init(height = -1, width = -1): + """ + Preparation for displaying a popup. This creates a popup with a valid + subwindow instance. If that's successful then the curses lock is acquired + and this returns a tuple of the... + (popup, draw width, draw height) + Otherwise this leaves curses unlocked and returns None. + + Arguments: + height - maximum height of the popup + width - maximum width of the popup + """ + + topSize = controller.getPanel("header").getHeight() + topSize += controller.getPanel("control").getHeight() + + popup = panel.Panel(controller.getScreen(), "popup", topSize, height, width) + popup.setVisible(True) + + # Redraws the popup to prepare a subwindow instance. If none is spawned then + # the panel can't be drawn (for instance, due to not being visible). + popup.redraw(True) + if popup.win != None: + panel.CURSES_LOCK.acquire() + return (popup, popup.maxX - 1, popup.maxY) + else: return None + +def finalize(): + """ + Cleans up after displaying a popup, releasing the cureses lock and redrawing + the rest of the display. + """ + + controller.refresh() + panel.CURSES_LOCK.release() + +def showHelpPopup(): + """ + Presents a popup with instructions for the current page's hotkeys. This + returns the user input used to close the popup. If the popup didn't close + properly, this is an arrow, enter, or scroll key then this returns None. + """ + + popup, width, height = init(9, 80) + if not popup: return + + exitKey = None + try: + pageNum = controller.getPage() + pagePanels = controller.getPanels(pageNum) + + # the first page is the only one with multiple panels, and it looks better + # with the log entries first, so reversing the order + pagePanels.reverse() + + helpOptions = [] + for entry in pagePanels: + helpOptions += entry.getHelp() + + # test doing afterward in case of overwriting + popup.win.box() + popup.addstr(0, 0, "Page %i Commands:" % pageNum, curses.A_STANDOUT) + + for i in range(len(helpOptions)): + if i / 2 >= height - 2: break + + # draws entries in the form '<key>: <description>[ (<selection>)]', for + # instance... + # u: duplicate log entries (hidden) + key, description, selection = helpOptions[i] + if key: description = ": " + description + row = (i / 2) + 1 + col = 2 if i % 2 == 0 else 41 + + popup.addstr(row, col, key, curses.A_BOLD) + col += len(key) + popup.addstr(row, col, description) + col += len(description) + + if selection: + popup.addstr(row, col, " (") + popup.addstr(row, col + 2, selection, curses.A_BOLD) + popup.addstr(row, col + 2 + len(selection), ")") + + # tells user to press a key if the lower left is unoccupied + if len(helpOptions) < 13 and height == 9: + popup.addstr(7, 2, "Press any key...") + + popup.win.refresh() + curses.cbreak() + exitKey = controller.getScreen().getch() + curses.halfdelay(controller.REFRESH_RATE * 10) + finally: finalize() + + if not uiTools.isSelectionKey(exitKey) and \ + not uiTools.isScrollKey(exitKey) and \ + not exitKey in (curses.KEY_LEFT, curses.KEY_RIGHT): + return exitKey + else: return None + diff --git a/src/cli/torrcPanel.py b/src/cli/torrcPanel.py index b7cad86..6d7156d 100644 --- a/src/cli/torrcPanel.py +++ b/src/cli/torrcPanel.py @@ -60,6 +60,18 @@ class TorrcPanel(panel.Panel): self.valsLock.release() + def getHelp(self): + options = [] + options.append(("up arrow", "scroll up a line", None)) + options.append(("down arrow", "scroll down a line", None)) + options.append(("page up", "scroll up a page", None)) + options.append(("page down", "scroll down a page", None)) + options.append(("s", "comment stripping", "on" if self.stripComments else "off")) + options.append(("n", "line numbering", "on" if self.showLineNum else "off")) + options.append(("r", "reload torrc", None)) + options.append(("x", "reset tor (issue sighup)", None)) + return options + def draw(self, width, height): self.valsLock.acquire() diff --git a/src/util/panel.py b/src/util/panel.py index 9c3dd29..7387833 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -290,6 +290,15 @@ class Panel(): if setWidth != -1: newWidth = min(newWidth, setWidth) return (newHeight, newWidth) + def getHelp(self): + """ + Provides help information for the controls this page provides. This is a + list of tuples of the form... + (control, description, status) + """ + + return [] + def draw(self, width, height): """ Draws display's content. This is meant to be overwritten by

1 0

[arm/release] fix: Help dialog inaccurate for config/torrc pages
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 3461c620e5fd16aea0fc40b9041cddc038718a8c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 4 09:46:46 2011 -0700 fix: Help dialog inaccurate for config/torrc pages Somehow while shuffling the pages the config page's help options were dropped and the torrc's was assigned to another page. Reassigned pages and filled in missing options. --- src/cli/controller.py | 15 +++++++++------ 1 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 08d7b17..91c34df 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -969,6 +969,15 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): popup.addfstr(1, 41, "down arrow: scroll down a line") popup.addfstr(2, 2, "page up: scroll up a page") popup.addfstr(2, 41, "page down: scroll down a page") + popup.addfstr(3, 2, "enter: edit configuration option") + popup.addfstr(3, 41, "w: save configuration") + popup.addfstr(4, 2, "a: toggle option filtering") + popup.addfstr(4, 41, "s: sort ordering") + elif page == 3: + popup.addfstr(1, 2, "up arrow: scroll up a line") + popup.addfstr(1, 41, "down arrow: scroll down a line") + popup.addfstr(2, 2, "page up: scroll up a page") + popup.addfstr(2, 41, "page down: scroll down a page") strippingLabel = "on" if panels["torrc"].stripComments else "off" popup.addfstr(3, 2, "s: comment stripping (%s)" % strippingLabel) @@ -978,12 +987,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): popup.addfstr(4, 2, "r: reload torrc") popup.addfstr(4, 41, "x: reset tor (issue sighup)") - elif page == 3: - popup.addfstr(1, 2, "up arrow: scroll up a line") - popup.addfstr(1, 41, "down arrow: scroll down a line") - popup.addfstr(2, 2, "page up: scroll up a page") - popup.addfstr(2, 41, "page down: scroll down a page") - popup.addfstr(3, 2, "enter: connection details") popup.addstr(7, 2, "Press any key...") popup.refresh()

1 0

[arm/release] fix: Making sure to load msg.* options on startup
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit de2e1b7a44543440aba5260ca4268aa8419c7de8 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 4 19:19:41 2011 -0700 fix: Making sure to load msg.* options on startup The msg.* config options wouldn't be loaded before warning of unused config options if we didn't deduplicate a log at startup. Also loading on panel creation to be sure it's done before issuing the warning. --- src/cli/logPanel.py | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index 7c1c19a..6feb129 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -530,6 +530,11 @@ class LogPanel(panel.Panel, threading.Thread): threading.Thread.__init__(self) self.setDaemon(True) + # Make sure that the msg.* messages are loaded. Lazy loading it later is + # fine, but this way we're sure it happens before warning about unused + # config options. + loadLogMessages() + self._config = dict(DEFAULT_CONFIG) if config:

1 0

[arm/release] fix: Initializing all panels to be hidden
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit a45b4fd97a801d22b2bf66f2809e560523738e63 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 4 19:36:19 2011 -0700 fix: Initializing all panels to be hidden A recent change to pausing functionality caused a timing issue where the log panel would redraw before being properly placed. The result was that the log panle's title flashes at the top of the screen at startup. This starts that panel (and all others) as hidden on init. --- src/cli/controller.py | 2 ++ src/util/panel.py | 2 +- 2 files changed, 3 insertions(+), 1 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 512e5ba..b8bb5cd 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -651,6 +651,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): lastSize = None # sets initial visiblity for the pages + for entry in PAGE_S: panels[entry].setVisible(True) + for i in range(len(PAGES)): isVisible = i == page for entry in PAGES[i]: panels[entry].setVisible(isVisible) diff --git a/src/util/panel.py b/src/util/panel.py index 4f8763c..9c3dd29 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -60,7 +60,7 @@ class Panel(): self.panelName = name self.parent = parent - self.visible = True + self.visible = False # Attributes for pausing. The pauseAttr contains variables our getAttr # method is tracking, and the pause buffer has copies of the values from

1 0

[arm/release] Adding procName util to readme and package
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 908acf3170058fc4deacba1fc2f82549d2d54c02 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 3 09:49:42 2011 -0700 Adding procName util to readme and package --- README | 1 + src/util/__init__.py | 2 +- 2 files changed, 2 insertions(+), 1 deletions(-) diff --git a/README b/README index 50657a1..ff03b37 100644 --- a/README +++ b/README @@ -172,6 +172,7 @@ Layout: log.py - aggregator for application events panel.py - wrapper for safely working with curses subwindows procTools.py - queries process & system information from /proc contents + procName.py - renames our process to a friendlier name sysTools.py - helper for system calls, providing client side caching torConfig.py - functions for working with the torrc and config options torTools.py - TorCtl wrapper, providing caching and derived information diff --git a/src/util/__init__.py b/src/util/__init__.py index dd65242..365e82a 100644 --- a/src/util/__init__.py +++ b/src/util/__init__.py @@ -4,5 +4,5 @@ application's status, making cross platform system calls, parsing tor data, and safely working with curses (hiding some of the gory details). """ -__all__ = ["conf", "connections", "enum", "hostnames", "log", "panel", "procTools", "sysTools", "torConfig", "torTools", "uiTools"] +__all__ = ["conf", "connections", "enum", "hostnames", "log", "panel", "procTools", "procName", "sysTools", "torConfig", "torTools", "uiTools"]

1 0

[arm/release] fix: Don't revert quit confirmation if 'yes'
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 45adb1c8036ef0b89eb58606fc2c559b38c82a27 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 4 19:10:56 2011 -0700 fix: Don't revert quit confirmation if 'yes' Due to changes in pause functionality the message when confirming that you want to quit would be reverted, even when you answer 'yes' to shut arm down (just a brief flicker while quitting). --- src/cli/controller.py | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 91c34df..512e5ba 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -808,7 +808,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): quitConfirmed = confirmationKey in (ord('q'), ord('Q')) curses.halfdelay(REFRESH_RATE * 10) - panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) + if not quitConfirmed: + panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) setPauseState(panels, isPaused, page) finally: panel.CURSES_LOCK.release()

1 0

[arm/release] Determining initial cmd with ctypes rather than ps
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 175fde6c4a92e1b52f060ef82baf35bf7d722639 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 2 21:28:54 2011 -0700 Determining initial cmd with ctypes rather than ps Using the ctypes argv rather than querying for our command via ps (thanks to ioerror). --- src/util/procname.py | 28 +++++++++++----------------- 1 files changed, 11 insertions(+), 17 deletions(-) diff --git a/src/util/procname.py b/src/util/procname.py index 14a82b8..97dc707 100644 --- a/src/util/procname.py +++ b/src/util/procname.py @@ -9,13 +9,10 @@ # argument replacement (ie, replace argv[0], argv[1], etc but with a string # the same size). -import os import sys import ctypes import ctypes.util -from util import sysTools - # flag for setting the process name, found in '/usr/include/linux/prctl.h' PR_SET_NAME = 15 @@ -65,24 +62,21 @@ def _setArgv(processName): if currentProcessName == None: # Getting argv via... # currentProcessName = " ".join(["python"] + sys.argv) - # + # # doesn't do the trick since this will miss interpretor arguments like... # python -W ignore::DeprecationWarning myScript.py # - # hence simply getting an outside opinion of our command. - - psResults = sysTools.call("ps -p %i -o args" % os.getpid()) + # Hence we're fetching this via our ctypes argv. Alternatively we could + # use ps, though this is less desirable: + # "ps -p %i -o args" % os.getpid() - if len(psResults) == 2: - # output looks like: - # COMMAND - # python ./src/starter.py - - currentProcessName = psResults[1] - maxNameLength = len(currentProcessName) + args = [] + for i in range(100): + if argc[i] == None: break + args.append(str(argc[i])) - if not currentProcessName: - raise IOError("unable to determine our process name") + currentProcessName = " ".join(args) + maxNameLength = len(currentProcessName) if len(processName) > maxNameLength: msg = "can't rename process to something longer than our initial name since this would overwrite memory used for the env" @@ -93,7 +87,7 @@ def _setArgv(processName): ctypes.memset(argc.contents, 0, zeroSize + 1) # null terminate the string's end ctypes.memmove(argc.contents, processName, len(processName)) - currentProcessName = processName[:MAX_CHAR] + currentProcessName = processName def _setPrctlName(processName): """

1 0

[arm/release] Renaming procname to procName
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 6c07b110c6b9b0d2285a5875d98647abaf8d67b8 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 3 09:47:52 2011 -0700 Renaming procname to procName The rest of the utils follow a camel-case convention so this one should too. --- src/starter.py | 4 +- src/util/procName.py | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++ src/util/procname.py | 115 -------------------------------------------------- 3 files changed, 117 insertions(+), 117 deletions(-) diff --git a/src/starter.py b/src/starter.py index 5b73a73..be97d0e 100644 --- a/src/starter.py +++ b/src/starter.py @@ -391,8 +391,8 @@ if __name__ == '__main__': # "arm <input args>" try: - from util import procname - procname.renameProcess("arm\0%s" % "\0".join(sys.argv[1:])) + from util import procName + procName.renameProcess("arm\0%s" % "\0".join(sys.argv[1:])) except: pass cli.controller.startTorMonitor(time.time() - initTime, expandedEvents, param["startup.blindModeEnabled"]) diff --git a/src/util/procName.py b/src/util/procName.py new file mode 100644 index 0000000..97dc707 --- /dev/null +++ b/src/util/procName.py @@ -0,0 +1,115 @@ +# Module to allow for arbitrary renaming of our python process. This is mostly +# based on: +# http://www.rhinocerus.net/forum/lang-python/569677-setting-program-name-lik… +# and an adaptation by Jake: https://github.com/ioerror/chameleon +# +# A cleaner implementation is available at: +# https://github.com/cream/libs/blob/b38970e2a6f6d2620724c828808235be0445b799… +# but I'm not quite clear on their implementation, and it only does targeted +# argument replacement (ie, replace argv[0], argv[1], etc but with a string +# the same size). + +import sys +import ctypes +import ctypes.util + +# flag for setting the process name, found in '/usr/include/linux/prctl.h' +PR_SET_NAME = 15 + +argc_t = ctypes.POINTER(ctypes.c_char_p) + +Py_GetArgcArgv = ctypes.pythonapi.Py_GetArgcArgv +Py_GetArgcArgv.restype = None +Py_GetArgcArgv.argtypes = [ctypes.POINTER(ctypes.c_int), + ctypes.POINTER(argc_t)] + +# tracks the last name we've changed the process to +currentProcessName = None +maxNameLength = -1 + +def renameProcess(processName): + """ + Renames our current process from "python <args>" to a custom name. + + Arguments: + processName - new name for our process + """ + + _setArgv(processName) + if sys.platform == "linux2": + _setPrctlName(processName) + elif sys.platform == "freebsd7": + _setProcTitle(processName) + +def _setArgv(processName): + """ + Overwrites our argv in a similar fashion to how it's done in C with: + strcpy(argv[0], "new_name"); + """ + + global currentProcessName, maxNameLength + + argv = ctypes.c_int(0) + argc = argc_t() + Py_GetArgcArgv(argv, ctypes.pointer(argc)) + + # The original author did the memset for 256, while Jake did it for the + # processName length (capped at 1608). I'm not sure of the reasons for + # either of these limits, but setting it to anything higher than than the + # length of the null terminated process name should be pointless, so opting + # for Jake's implementation on this. + + if currentProcessName == None: + # Getting argv via... + # currentProcessName = " ".join(["python"] + sys.argv) + # + # doesn't do the trick since this will miss interpretor arguments like... + # python -W ignore::DeprecationWarning myScript.py + # + # Hence we're fetching this via our ctypes argv. Alternatively we could + # use ps, though this is less desirable: + # "ps -p %i -o args" % os.getpid() + + args = [] + for i in range(100): + if argc[i] == None: break + args.append(str(argc[i])) + + currentProcessName = " ".join(args) + maxNameLength = len(currentProcessName) + + if len(processName) > maxNameLength: + msg = "can't rename process to something longer than our initial name since this would overwrite memory used for the env" + raise IOError(msg) + + # space we need to clear + zeroSize = max(len(currentProcessName), len(processName)) + + ctypes.memset(argc.contents, 0, zeroSize + 1) # null terminate the string's end + ctypes.memmove(argc.contents, processName, len(processName)) + currentProcessName = processName + +def _setPrctlName(processName): + """ + Sets the prctl name, which is used by top and killall. This appears to be + Linux specific and has the max of 15 characters. Source: + http://stackoverflow.com/questions/564695/is-there-a-way-to-change-effectiv… + """ + + libc = ctypes.CDLL(ctypes.util.find_library("c")) + nameBuffer = ctypes.create_string_buffer(len(processName)+1) + nameBuffer.value = processName + libc.prctl(PR_SET_NAME, ctypes.byref(nameBuffer), 0, 0, 0) + +def _setProcTitle(processName): + """ + BSD specific calls (should be compataible with both FreeBSD and OpenBSD: + http://fxr.watson.org/fxr/source/gen/setproctitle.c?v=FREEBSD-LIBC + http://www.rootr.net/man/man/setproctitle/3 + """ + + libc = ctypes.CDLL(ctypes.util.find_library("c")) + nameBuffer = ctypes.create_string_buffer(len(processName)+1) + nameBuffer.value = processName + libc.setproctitle(ctypes.byref(nameBuffer)) + diff --git a/src/util/procname.py b/src/util/procname.py deleted file mode 100644 index 97dc707..0000000 --- a/src/util/procname.py +++ /dev/null @@ -1,115 +0,0 @@ -# Module to allow for arbitrary renaming of our python process. This is mostly -# based on: -# http://www.rhinocerus.net/forum/lang-python/569677-setting-program-name-lik… -# and an adaptation by Jake: https://github.com/ioerror/chameleon -# -# A cleaner implementation is available at: -# https://github.com/cream/libs/blob/b38970e2a6f6d2620724c828808235be0445b799… -# but I'm not quite clear on their implementation, and it only does targeted -# argument replacement (ie, replace argv[0], argv[1], etc but with a string -# the same size). - -import sys -import ctypes -import ctypes.util - -# flag for setting the process name, found in '/usr/include/linux/prctl.h' -PR_SET_NAME = 15 - -argc_t = ctypes.POINTER(ctypes.c_char_p) - -Py_GetArgcArgv = ctypes.pythonapi.Py_GetArgcArgv -Py_GetArgcArgv.restype = None -Py_GetArgcArgv.argtypes = [ctypes.POINTER(ctypes.c_int), - ctypes.POINTER(argc_t)] - -# tracks the last name we've changed the process to -currentProcessName = None -maxNameLength = -1 - -def renameProcess(processName): - """ - Renames our current process from "python <args>" to a custom name. - - Arguments: - processName - new name for our process - """ - - _setArgv(processName) - if sys.platform == "linux2": - _setPrctlName(processName) - elif sys.platform == "freebsd7": - _setProcTitle(processName) - -def _setArgv(processName): - """ - Overwrites our argv in a similar fashion to how it's done in C with: - strcpy(argv[0], "new_name"); - """ - - global currentProcessName, maxNameLength - - argv = ctypes.c_int(0) - argc = argc_t() - Py_GetArgcArgv(argv, ctypes.pointer(argc)) - - # The original author did the memset for 256, while Jake did it for the - # processName length (capped at 1608). I'm not sure of the reasons for - # either of these limits, but setting it to anything higher than than the - # length of the null terminated process name should be pointless, so opting - # for Jake's implementation on this. - - if currentProcessName == None: - # Getting argv via... - # currentProcessName = " ".join(["python"] + sys.argv) - # - # doesn't do the trick since this will miss interpretor arguments like... - # python -W ignore::DeprecationWarning myScript.py - # - # Hence we're fetching this via our ctypes argv. Alternatively we could - # use ps, though this is less desirable: - # "ps -p %i -o args" % os.getpid() - - args = [] - for i in range(100): - if argc[i] == None: break - args.append(str(argc[i])) - - currentProcessName = " ".join(args) - maxNameLength = len(currentProcessName) - - if len(processName) > maxNameLength: - msg = "can't rename process to something longer than our initial name since this would overwrite memory used for the env" - raise IOError(msg) - - # space we need to clear - zeroSize = max(len(currentProcessName), len(processName)) - - ctypes.memset(argc.contents, 0, zeroSize + 1) # null terminate the string's end - ctypes.memmove(argc.contents, processName, len(processName)) - currentProcessName = processName - -def _setPrctlName(processName): - """ - Sets the prctl name, which is used by top and killall. This appears to be - Linux specific and has the max of 15 characters. Source: - http://stackoverflow.com/questions/564695/is-there-a-way-to-change-effectiv… - """ - - libc = ctypes.CDLL(ctypes.util.find_library("c")) - nameBuffer = ctypes.create_string_buffer(len(processName)+1) - nameBuffer.value = processName - libc.prctl(PR_SET_NAME, ctypes.byref(nameBuffer), 0, 0, 0) - -def _setProcTitle(processName): - """ - BSD specific calls (should be compataible with both FreeBSD and OpenBSD: - http://fxr.watson.org/fxr/source/gen/setproctitle.c?v=FREEBSD-LIBC - http://www.rootr.net/man/man/setproctitle/3 - """ - - libc = ctypes.CDLL(ctypes.util.find_library("c")) - nameBuffer = ctypes.create_string_buffer(len(processName)+1) - nameBuffer.value = processName - libc.setproctitle(ctypes.byref(nameBuffer)) -

1 0

[arm/release] fix: connection resolution test was nonfunctional
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 8364fc6a47238053738cce70f3cf9debe0cfb088 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 9 08:28:47 2011 -0700 fix: connection resolution test was nonfunctional The second test (running targeted connection resolvers) was broken due to changes in the connection util. --- src/test.py | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/test.py b/src/test.py index e403076..af80879 100644 --- a/src/test.py +++ b/src/test.py @@ -78,9 +78,9 @@ while True: printDivider() break - if userSelection.isdigit() and int(userSelection) in range(1, 8): + if userSelection.isdigit() and int(userSelection) in range(0, 7): try: - resolver = int(userSelection) + resolver = connections.Resolver.values()[int(userSelection)] startTime = time.time() print(connections.getResolverCommand(resolver, "tor", conn.getMyPid())) @@ -93,7 +93,7 @@ while True: print(" %s:%s -> %s:%s" % (lIp, lPort, fIp, fPort)) print("\n Runtime: %0.4f seconds" % (time.time() - startTime)) - except IOError, exc: + except (IOError, IndexError), exc: print exc else: print("'%s' isn't a valid selection\n" % userSelection)

1 0