- tor-commits - lists.torproject.org

[arm/release] Making curses text input extensible
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit dc18065b395ef409cfff58525f24bb0727ac3ed6 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 23 09:34:14 2011 -0700 Making curses text input extensible Adding utility for text input interceptors which can be chained to add capabilities to text input fields (like tab completion). They'll be implemented as needed. --- README | 1 + src/util/__init__.py | 2 +- src/util/panel.py | 59 +++------------------------- src/util/textInput.py | 101 +++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 110 insertions(+), 53 deletions(-) diff --git a/README b/README index cbaf31a..16d0965 100644 --- a/README +++ b/README @@ -205,6 +205,7 @@ Layout: 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 + textInput.py - expands the capabilities of text input fields torConfig.py - functions for working with the torrc and config options torTools.py - TorCtl wrapper, providing caching and derived information uiTools.py - helper functions for presenting the user interface diff --git a/src/util/__init__.py b/src/util/__init__.py index cd5d721..973527e 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", "gtkTools", "hostnames", "log", "panel", "procTools", "procName", "sysTools", "torConfig", "torTools", "uiTools"] +__all__ = ["conf", "connections", "enum", "gtkTools", "hostnames", "log", "panel", "procTools", "procName", "sysTools", "textInput", "torConfig", "torTools", "uiTools"] diff --git a/src/util/panel.py b/src/util/panel.py index 0e84005..50ae2c0 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -9,7 +9,7 @@ import curses.ascii import curses.textpad from threading import RLock -from util import log, uiTools +from util import log, textInput, uiTools # global ui lock governing all panel instances (curses isn't thread save and # concurrency bugs produce especially sinister glitches) @@ -575,7 +575,7 @@ class Panel(): baseMsg = "Unclosed formatting tag%s:" % ("s" if len(expectedCloseTags) > 1 else "") raise ValueError("%s: '%s'\n \"%s\"" % (baseMsg, "', '".join(expectedCloseTags), msg)) - def getstr(self, y, x, initialText = "", format = None, maxWidth = None): + def getstr(self, y, x, initialText = "", format = None, maxWidth = None, validator = None): """ Provides a text field where the user can input a string, blocking until they've done so and returning the result. If the user presses escape then @@ -592,6 +592,7 @@ class Panel(): initialText - starting text in this field format - format used for the text maxWidth - maximum width for the text field + validator - custom TextInputValidator for handling keybindings """ if not format: format = curses.A_NORMAL @@ -619,8 +620,11 @@ class Panel(): textbox = curses.textpad.Textbox(inputSubwindow) + if not validator: + validator = textInput.BasicValidator() + textbox.win.attron(format) - userInput = textbox.edit(lambda key: _textboxValidate(textbox, key)).strip() + userInput = textbox.edit(lambda key: validator.validate(key, textbox)).strip() textbox.win.attroff(format) if textbox.lastcmd == curses.ascii.BEL: userInput = None @@ -727,52 +731,3 @@ class Panel(): log.log(CONFIG["log.panelRecreated"], msg) return recreate -def _textboxValidate(textbox, key): - """ - Interceptor for keystrokes given to a textbox, doing the following: - - quits by setting the input to curses.ascii.BEL when escape is pressed - - stops the cursor at the end of the box's content when pressing the right - arrow - - home and end keys move to the start/end of the line - """ - - y, x = textbox.win.getyx() - - if curses.ascii.isprint(key) and x < textbox.maxx: - # Shifts the existing text forward so input is an insert method rather - # than replacement. The curses.textpad accepts an insert mode flag but - # this has a couple issues... - # - The flag is only available for Python 2.6+, before that the - # constructor only accepted a subwindow argument as per: - # https://trac.torproject.org/projects/tor/ticket/2354 - # - The textpad doesn't shift text that has text attributes. This is - # because keycodes read by textbox.win.inch() includes formatting, - # causing the curses.ascii.isprint() check it does to fail. - - currentInput = textbox.gather() - textbox.win.addstr(y, x + 1, currentInput[x:textbox.maxx - 1]) - textbox.win.move(y, x) # reverts cursor movement during gather call - elif key == 27: - # curses.ascii.BEL is a character codes that causes textpad to terminate - return curses.ascii.BEL - elif key == curses.KEY_HOME: - textbox.win.move(y, 0) - return None - elif key in (curses.KEY_END, curses.KEY_RIGHT): - msgLen = len(textbox.gather()) - textbox.win.move(y, x) # reverts cursor movement during gather call - - if key == curses.KEY_END and msgLen > 0 and x < msgLen - 1: - # if we're in the content then move to the end - textbox.win.move(y, msgLen - 1) - return None - elif key == curses.KEY_RIGHT and x >= msgLen - 1: - # don't move the cursor if there's no content after it - return None - elif key == 410: - # if we're resizing the display during text entry then cancel it - # (otherwise the input field is filled with nonprintable characters) - return curses.ascii.BEL - - return key - diff --git a/src/util/textInput.py b/src/util/textInput.py new file mode 100644 index 0000000..9422f81 --- /dev/null +++ b/src/util/textInput.py @@ -0,0 +1,101 @@ +""" +Provides input validators that provide text input with various capabilities. +These can be chained together with the first matching validator taking +precidence. +""" + +import curses + +PASS = -1 + +class TextInputValidator: + """ + Basic interface for validators. Implementations should override the handleKey + method. + """ + + def __init__(self, nextValidator = None): + self.nextValidator = nextValidator + + def validate(self, key, textbox): + """ + Processes the given key input for the textbox. This may modify the + textbox's content, cursor position, etc depending on the functionality + of the validator. This returns the key that the textbox should interpret, + PASS if this validator doesn't want to take any action. + + Arguments: + key - key code input from the user + textbox - curses Textbox instance the input came from + """ + + result = self.handleKey(key, textbox) + + if result != PASS: + return result + elif self.nextValidator: + return self.nextValidator.validate(key, textbox) + else: return key + + def handleKey(self, key, textbox): + """ + Process the given keycode with this validator, returning the keycode for + the textbox to process, and PASS if this doesn't want to modify it. + + Arguments: + key - key code input from the user + textbox - curses Textbox instance the input came from + """ + + return PASS + +class BasicValidator(TextInputValidator): + """ + Interceptor for keystrokes given to a textbox, doing the following: + - quits by setting the input to curses.ascii.BEL when escape is pressed + - stops the cursor at the end of the box's content when pressing the right + arrow + - home and end keys move to the start/end of the line + """ + + def handleKey(self, key, textbox): + y, x = textbox.win.getyx() + + if curses.ascii.isprint(key) and x < textbox.maxx: + # Shifts the existing text forward so input is an insert method rather + # than replacement. The curses.textpad accepts an insert mode flag but + # this has a couple issues... + # - The flag is only available for Python 2.6+, before that the + # constructor only accepted a subwindow argument as per: + # https://trac.torproject.org/projects/tor/ticket/2354 + # - The textpad doesn't shift text that has text attributes. This is + # because keycodes read by textbox.win.inch() includes formatting, + # causing the curses.ascii.isprint() check it does to fail. + + currentInput = textbox.gather() + textbox.win.addstr(y, x + 1, currentInput[x:textbox.maxx - 1]) + textbox.win.move(y, x) # reverts cursor movement during gather call + elif key == 27: + # curses.ascii.BEL is a character codes that causes textpad to terminate + return curses.ascii.BEL + elif key == curses.KEY_HOME: + textbox.win.move(y, 0) + return None + elif key in (curses.KEY_END, curses.KEY_RIGHT): + msgLen = len(textbox.gather()) + textbox.win.move(y, x) # reverts cursor movement during gather call + + if key == curses.KEY_END and msgLen > 0 and x < msgLen - 1: + # if we're in the content then move to the end + textbox.win.move(y, msgLen - 1) + return None + elif key == curses.KEY_RIGHT and x >= msgLen - 1: + # don't move the cursor if there's no content after it + return None + elif key == 410: + # if we're resizing the display during text entry then cancel it + # (otherwise the input field is filled with nonprintable characters) + return curses.ascii.BEL + + return PASS +

1 0

[arm/release] Adding text input validator for command backlogs
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit ec436c57401218a9680edbae4e1e043f3c977b30 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 23 10:07:27 2011 -0700 Adding text input validator for command backlogs This allows the up and down arrow keys to scroll through a backlog of commands (it'll be used in the interpretor panel). --- src/util/textInput.py | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 49 insertions(+), 0 deletions(-) diff --git a/src/util/textInput.py b/src/util/textInput.py index 9422f81..c3c229f 100644 --- a/src/util/textInput.py +++ b/src/util/textInput.py @@ -99,3 +99,52 @@ class BasicValidator(TextInputValidator): return PASS +class HistoryValidator(TextInputValidator): + """ + This intercepts the up and down arrow keys to scroll through a backlog of + previous commands. + """ + + def __init__(self, commandBacklog = [], nextValidator = None): + TextInputValidator.__init__(self, nextValidator) + + # contents that can be scrolled back through, newest to oldest + self.commandBacklog = commandBacklog + + # selected item from the backlog, -1 if we're not on a backlog item + self.selectionIndex = -1 + + # the fields input prior to selecting a backlog item + self.customInput = "" + + def handleKey(self, key, textbox): + if key in (curses.KEY_UP, curses.KEY_DOWN): + offset = 1 if key == curses.KEY_UP else -1 + newSelection = self.selectionIndex + offset + + # constrains the new selection to valid bounds + newSelection = max(-1, newSelection) + newSelection = min(len(self.commandBacklog) - 1, newSelection) + + # skips if this is a no-op + if self.selectionIndex == newSelection: + return None + + # saves the previous input if we weren't on the backlog + if self.selectionIndex == -1: + self.customInput = textbox.gather().strip() + + if newSelection == -1: newInput = self.customInput + else: newInput = self.commandBacklog[newSelection] + + y, _ = textbox.win.getyx() + _, maxX = textbox.win.getmaxyx() + textbox.win.clear() + textbox.win.addstr(y, 0, newInput[:maxX - 1]) + textbox.win.move(y, min(len(newInput), maxX - 1)) + + self.selectionIndex = newSelection + return None + + return PASS +

1 0

[arm/release] Skeleton terminal contorl interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit ba49077b953265515aef1b2b98b159636f37d7c5 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 10:15:24 2011 -0700 Skeleton terminal contorl interpretor This provides a basic skeleton for a terminal-only interpretor of the control port. This provides terminal coloring, formatting, and history scollback but it not yet tied into the control port. The plan is that both the torInterpretor and interpretorPanel will use the same backend for irc style interpretor commands so people can use the interpretor in both the curses interface or plain terminal. --- src/util/torInterpretor.py | 66 ++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 66 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py new file mode 100644 index 0000000..9b6bff4 --- /dev/null +++ b/src/util/torInterpretor.py @@ -0,0 +1,66 @@ +""" +Provides an interactive interpretor for working with the Tor control port. This +adds usability features like IRC style interpretor commands and, when ran +directly, history and tab completion. +""" + +import readline # simply importing this provides history to raw_input + +from util import enum + +TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE") + +Color = enum.Enum(*TERM_COLORS) +BgColor = enum.Enum(*["BG_" + color for color in TERM_COLORS]) +Attr = enum.Enum("BOLD", "UNDERLINE", "HILIGHT") + +FG_ENCODING = dict([(Color.values()[i], str(30 + i)) for i in range(8)]) +BG_ENCODING = dict([(BgColor.values()[i], str(40 + i)) for i in range(8)]) +ATTR_ENCODING = {Attr.BOLD: "1", Attr.UNDERLINE: "4", Attr.HILIGHT: "7"} + +CSI = "\x1B[%sm" +RESET = CSI % "0" + +def format(msg, *attr): + """ + Simple terminal text formatting, using ANSI escape sequences from: + https://secure.wikimedia.org/wikipedia/en/wiki/ANSI_escape_code#CSI_codes + + toolkits providing similar capabilities: + * django.utils.termcolors + https://code.djangoproject.com/browser/django/trunk/django/utils/termcolors… + + * termcolor + http://pypi.python.org/pypi/termcolor + + * colorama + http://pypi.python.org/pypi/colorama + + Arguments: + msg - string to be formatted + attr - text attributes, this can be Color, BgColor, or Attr enums and are + case insensitive (so strings like "red" are fine) + """ + + encodings = [] + for textAttr in attr: + textAttr, encoding = enum.toCamelCase(textAttr), None + encoding = FG_ENCODING.get(textAttr, encoding) + encoding = BG_ENCODING.get(textAttr, encoding) + encoding = ATTR_ENCODING.get(textAttr, encoding) + if encoding: encodings.append(encoding) + + if encodings: + return (CSI % ";".join(encodings)) + msg + RESET + else: + raise IOError("BLARG! %s" % str(attr)) + return msg + +def prompt(): + prompt = format(">>> ", Color.GREEN, Attr.BOLD) + input = "" + + while input != "/quit": + input = raw_input(prompt) + print format("echoing back '%s'" % input, Color.BLUE) +

1 0

[arm/release] Interpretor panel for raw control port access
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 0016b2be0fac62ae840a1259ee65269defa3654c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 24 10:07:24 2011 -0700 Interpretor panel for raw control port access This adds a new page to the interface, providing an interactive interpretor that lets the user send/receive control commands. This includes history search and will be expanded to have other usability features (tab completion, search, etc). --- README | 1 + src/cli/__init__.py | 2 +- src/cli/controller.py | 3 + src/cli/interpretorPanel.py | 232 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 237 insertions(+), 1 deletions(-) diff --git a/README b/README index 16d0965..cbaf2f7 100644 --- a/README +++ b/README @@ -193,6 +193,7 @@ Layout: logPanel.py - (page 1) displays tor, arm, and torctl events configPanel.py - (page 3) editor panel for the tor configuration torrcPanel.py - (page 4) displays torrc and validation + interpretorPanel.py - (page 5) interpretor for control port access util/ __init__.py diff --git a/src/cli/__init__.py b/src/cli/__init__.py index b0d6bd8..fa23640 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", "headerPanel", "logPanel", "popups", "torrcPanel", "wizard"] +__all__ = ["configPanel", "controller", "headerPanel", "interpretorPanel", "logPanel", "popups", "torrcPanel", "wizard"] diff --git a/src/cli/controller.py b/src/cli/controller.py index d2194ca..bc69e79 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -15,6 +15,7 @@ import cli.headerPanel import cli.logPanel import cli.configPanel import cli.torrcPanel +import cli.interpretorPanel import cli.graphing.graphPanel import cli.graphing.bandwidthStats import cli.graphing.connStats @@ -97,6 +98,8 @@ def initController(stdscr, startTime): if CONFIG["features.panels.show.torrc"]: pagePanels.append([cli.torrcPanel.TorrcPanel(stdscr, cli.torrcPanel.Config.TORRC, config)]) + pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) + # initializes the controller ARM_CONTROLLER = Controller(stdscr, stickyPanels, pagePanels) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py new file mode 100644 index 0000000..b7c3fe0 --- /dev/null +++ b/src/cli/interpretorPanel.py @@ -0,0 +1,232 @@ +""" +Panel providing raw control port access with syntax hilighting, usage +information, tab completion, and other usability features. +""" + +import curses + +from util import enum, panel, textInput, torTools, uiTools + +from TorCtl import TorCtl + +Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") + +PROMPT = ">>> " +USAGE_INFO = "to use this panel press enter" + +# limits used for cropping +COMMAND_BACKLOG = 100 +LINES_BACKLOG = 2000 + +class InterpretorPanel(panel.Panel): + def __init__(self, stdscr): + panel.Panel.__init__(self, stdscr, "interpretor", 0) + self.isInputMode = False + self.scroll = 0 + self.formats = {} # lazy loaded curses formatting constants + self.previousCommands = [] # user input, newest to oldest + + # contents of the panel (oldest to newest), each line is a list of (msg, + # format enum) tuples + + self.contents = [[(PROMPT, Formats.PROMPT), (USAGE_INFO, Formats.USAGE)]] + + def prompt(self): + """ + Enables the interpretor, prompting for input until the user enters esc or + a blank line. + """ + + if not self.formats: self._initFormats() + self.isInputMode = True + + panel.CURSES_LOCK.acquire() + + while self.isInputMode: + self.redraw(True) + + # intercepts input so user can cycle through the history + validator = textInput.BasicValidator() + validator = textInput.HistoryValidator(self.previousCommands, validator) + + xOffset = len(PROMPT) + if len(self.contents) > self.maxY - 1: + xOffset += 3 # offset for scrollbar + + input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[Formats.INPUT], validator = validator) + + isDone = self.handleQuery(input) + + if isDone: + self.isInputMode = False + self.redraw(True) + + panel.CURSES_LOCK.release() + + def handleQuery(self, input): + """ + Processes the given input. Requests starting with a '/' are special + commands to the interpretor, and anything else is sent to the control port. + This returns a boolean to indicate if the interpretor should terminate or + not. + + Arguments: + input - user input to be processed + """ + + if not input or not input.strip(): return True + input = input.strip() + inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] + conn = torTools.getConn() + + # input falls into three general categories: + # - interpretor command which starts with a '/' + # - controller commands handled by torTools (this allows for caching, + # proper handling by the rest of arm, etc) + # - unrecognized controller command, this has the possability of confusing + # arm... + + if input.startswith("/"): + # interpretor command + inputEntry.append((input, Formats.INPUT_INTERPRETOR)) + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + + # TODO: add /help option + # TODO: add /write option + else: + # controller command + if " " in input: cmd, arg = input.split(" ", 1) + else: cmd, arg = input, "" + + inputEntry.append((cmd + " ", Formats.INPUT_CMD)) + if arg: inputEntry.append((arg, Formats.INPUT_ARG)) + + if cmd.upper() == "GETINFO": + try: + response = conn.getInfo(arg, suppressExc = False) + outputEntry.append((response, Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + elif cmd.upper() == "SETCONF": + if "=" in arg: + param, value = arg.split("=", 1) + + try: + conn.setOption(param.strip(), value.strip()) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + else: + # TODO: resets the attribute + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + else: + try: + response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + + for entry in response: + # Response entries are tuples with the response code, body, and + # extra info. For instance: + # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) + + if len(entry) == 3: + outputEntry.append((entry[1], Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + + self.previousCommands.insert(0, input) + self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + + promptEntry = self.contents.pop() # removes old prompt entry + self.contents += _splitOnNewlines(inputEntry) + self.contents += _splitOnNewlines(outputEntry) + self.contents.append(promptEntry) + + # if too long then crop lines + cropLines = len(self.contents) - LINES_BACKLOG + if cropLines > 0: self.contents = self.contents[cropLines:] + + return False + + def handleKey(self, key): + # TODO: allow contents to be searched (with hilighting?) + + isKeystrokeConsumed = True + if uiTools.isSelectionKey(key): + self.prompt() + elif uiTools.isScrollKey(key) and not self.isInputMode: + pageHeight = self.getPreferredSize()[0] - 1 + newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, len(self.contents)) + + if self.scroll != newScroll: + self.scroll = newScroll + self.redraw(True) + else: isKeystrokeConsumed = False + + return isKeystrokeConsumed + + def draw(self, width, height): + if not self.formats: self._initFormats() + + # page title + usageMsg = " (enter \"/help\" for usage or a blank line to stop)" if self.isInputMode else "" + self.addstr(0, 0, "Control Interpretor%s:" % usageMsg, curses.A_STANDOUT) + + xOffset = 0 + if len(self.contents) > height - 1: + # if we're in input mode then make sure the last line is visible + if self.isInputMode: + self.scroll = len(self.contents) - height + 1 + + xOffset = 3 + self.addScrollBar(self.scroll, self.scroll + height - 1, len(self.contents), 1) + + # draws prior commands and output + drawLine = 1 + for entry in self.contents[self.scroll:]: + cursor = xOffset + + for msg, formatEntry in entry: + format = self.formats.get(formatEntry, curses.A_NORMAL) + self.addstr(drawLine, cursor, msg, format) + cursor += len(msg) + + drawLine += 1 + if drawLine >= height: break + + def _initFormats(self): + self.formats[Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + self.formats[Formats.INPUT] = uiTools.getColor("cyan") + self.formats[Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + self.formats[Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + self.formats[Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + self.formats[Formats.OUTPUT] = uiTools.getColor("blue") + self.formats[Formats.USAGE] = uiTools.getColor("cyan") + self.formats[Formats.HELP] = uiTools.getColor("magenta") + self.formats[Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") + +def _splitOnNewlines(entry): + """ + Splits a list of (msg, format) tuples on newlines into a list of lines. + + Arguments: + entry - list of display tuples + """ + + results, tmpLine = [], [] + entry = list(entry) # shallow copy + + while entry: + msg, format = entry.pop(0) + + if "\n" in msg: + msg, remainder = msg.split("\n", 1) + entry.insert(0, (remainder, format)) + + tmpLine.append((msg, format)) + results.append(tmpLine) + tmpLine = [] + else: + tmpLine.append((msg, format)) + + if tmpLine: results.append(tmpLine) + return results +

1 0

[arm/release] fix: preventing prompt launch without tor instance
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 1bdc11a0df6b35530b1dfa5a5c033cbcd88a4845 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 07:54:56 2011 -0700 fix: preventing prompt launch without tor instance It doesn't really make sense to allow the control prompt to launch when we're unable to connect to tor. --- src/starter.py | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/src/starter.py b/src/starter.py index 5b86c10..ff2f4a8 100644 --- a/src/starter.py +++ b/src/starter.py @@ -386,6 +386,10 @@ if __name__ == '__main__': msg = STANDARD_CFG_NOT_FOUND_MSG % configPath util.log.log(util.log.NOTICE, msg) + # when launching a prompt it doens't make sense to be without a tor instance + if launchPrompt: + config.set("features.allowDetachedStartup", "false") + # revises defaults to match user's configuration config.update(CONFIG)

1 0

[arm/release] Option to just start the control interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 3e1a13538a4afa9ef2d66367b21e6d13ab7bc528 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 18:19:28 2011 -0700 Option to just start the control interpretor The control interpretor can be ran in either a curses panel or terminal prompt so giving an arm startup option for the later. --- src/starter.py | 12 +++++++++--- 1 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/starter.py b/src/starter.py index 2a81cd2..5b86c10 100644 --- a/src/starter.py +++ b/src/starter.py @@ -25,6 +25,7 @@ import util.panel import util.procTools import util.sysTools import util.torConfig +import util.torInterpretor import util.torTools import util.uiTools import TorCtl.TorCtl @@ -53,13 +54,14 @@ CONFIG = {"startup.controlPassword": None, "log.configDescriptions.persistance.saveFailed": util.log.NOTICE, "log.savingDebugLog": util.log.NOTICE} -OPT = "gi:s:c:dbe:vh" -OPT_EXPANDED = ["gui", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] +OPT = "gpi:s:c:dbe:vh" +OPT_EXPANDED = ["gui", "prompt", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] HELP_MSG = """Usage arm [OPTION] Terminal status monitor for Tor relays. -g, --gui launch the Gtk+ interface + -p, --prompt only start the control interpretor -i, --interface [ADDRESS:]PORT change control interface from %s:%i -s, --socket SOCKET_PATH attach using unix domain socket if present, SOCKET_PATH defaults to: %s @@ -298,6 +300,7 @@ if __name__ == '__main__': startTime = time.time() param = dict([(key, None) for key in CONFIG.keys()]) launchGui = False + launchPrompt = False isDebugMode = False configPath = DEFAULT_CONFIG # path used for customized configuration @@ -329,6 +332,7 @@ if __name__ == '__main__': elif opt in ("-s", "--socket"): param["startup.interface.socket"] = arg elif opt in ("-g", "--gui"): launchGui = True + elif opt in ("-p", "--prompt"): launchPrompt = True elif opt in ("-c", "--config"): configPath = arg # sets path of user's config elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs elif opt in ("-b", "--blind"): @@ -486,9 +490,11 @@ if __name__ == '__main__': if util.uiTools.isUnicodeAvailable(): locale.setlocale(locale.LC_ALL, "") - if launchGui == True: + if launchGui: import gui.controller gui.controller.start_gui() + elif launchPrompt: + util.torInterpretor.prompt() else: cli.controller.startTorMonitor(time.time() - initTime)

1 0

[arm/release] fix: adding config option to drop interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit aa73b588dc8df25c2f60e6afcc2702d3b2af7754 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 18:26:19 2011 -0700 fix: adding config option to drop interpretor All of the panels can be included/excluded via the user's armrc configuration. Applying that to the interpretor panel too. --- armrc.sample | 1 + src/cli/controller.py | 4 +++- 2 files changed, 4 insertions(+), 1 deletions(-) diff --git a/armrc.sample b/armrc.sample index e19d4c4..8f65fbc 100644 --- a/armrc.sample +++ b/armrc.sample @@ -18,6 +18,7 @@ features.panels.show.log true features.panels.show.connection true features.panels.show.config true features.panels.show.torrc true +features.panels.show.interpretor true # Read the proc contents directly instead of calling ps, netstat, and other # resolvers. This provides very sizable performance benefits (around 90% diff --git a/src/cli/controller.py b/src/cli/controller.py index bc69e79..a0b465c 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -37,6 +37,7 @@ CONFIG = {"startup.events": "N3", "features.panels.show.connection": True, "features.panels.show.config": True, "features.panels.show.torrc": True, + "features.panels.show.interpretor": True, "features.redrawRate": 5, "features.refreshRate": 5, "features.confirmQuit": True, @@ -98,7 +99,8 @@ def initController(stdscr, startTime): if CONFIG["features.panels.show.torrc"]: pagePanels.append([cli.torrcPanel.TorrcPanel(stdscr, cli.torrcPanel.Config.TORRC, config)]) - pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) + if CONFIG["features.panels.show.interpretor"]: + pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) # initializes the controller ARM_CONTROLLER = Controller(stdscr, stickyPanels, pagePanels)

1 0

[arm/release] Tidying up the interpretor panel
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d8d13f5fe5be8a29732d73d535df963aca34c8d9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 28 14:57:43 2011 -0700 Tidying up the interpretor panel --- src/cli/interpretorPanel.py | 72 +++++++++++++++++++++++------------------- 1 files changed, 39 insertions(+), 33 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index b81fa85..162fd19 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -5,28 +5,48 @@ information, tab completion, and other usability features. import curses -from util import enum, panel, textInput, torInterpretor, torTools, uiTools - -from TorCtl import TorCtl +from util import panel, textInput, torInterpretor, uiTools USAGE_INFO = "to use this panel press enter" +PROMPT_LINE = [(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)] # limits used for cropping -COMMAND_BACKLOG = 100 -LINES_BACKLOG = 2000 +BACKLOG_LIMIT = 100 +LINES_LIMIT = 2000 + +# lazy loaded curses formatting constants +FORMATS = {} + +def getFormat(format): + """ + Provides the curses drawing attributes for a torInterpretor.Formats enum. + This returns plain formatting if the entry doesn't exist. + + Arguments: + format - format enum to fetch + """ + + # initializes formats if they haven't yet been loaded + if not FORMATS: + FORMATS[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + FORMATS[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + FORMATS[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + FORMATS[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") + FORMATS[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") + FORMATS[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") + + return FORMATS.get(format, curses.A_NORMAL) class InterpretorPanel(panel.Panel): def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, "interpretor", 0) self.isInputMode = False self.scroll = 0 - self.formats = {} # lazy loaded curses formatting constants - self.previousCommands = [] # user input, newest to oldest - - # contents of the panel (oldest to newest), each line is a list of (msg, - # format enum) tuples - - self.contents = [[(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)]] + self.previousCommands = [] # user input, newest to oldest + self.contents = [PROMPT_LINE] # (msg, format enum) tuples being displayed (oldest to newest) def prompt(self): """ @@ -34,9 +54,7 @@ class InterpretorPanel(panel.Panel): a blank line. """ - if not self.formats: self._initFormats() self.isInputMode = True - panel.CURSES_LOCK.acquire() while self.isInputMode: @@ -50,14 +68,17 @@ class InterpretorPanel(panel.Panel): if len(self.contents) > self.maxY - 1: xOffset += 3 # offset for scrollbar - input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[torInterpretor.Formats.INPUT], validator = validator) + inputLine = min(self.maxY - 1, len(self.contents)) + inputFormat = getFormat(torInterpretor.Formats.INPUT) + input = self.getstr(inputLine, xOffset, "", inputFormat, validator = validator) input, isDone = input.strip(), False if not input: + # terminate input when we get a blank line isDone = True else: self.previousCommands.insert(0, input) - self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + self.previousCommands = self.previousCommands[:BACKLOG_LIMIT] try: inputEntry, outputEntry = torInterpretor.handleQuery(input) @@ -70,7 +91,7 @@ class InterpretorPanel(panel.Panel): self.contents.append(promptEntry) # if too long then crop lines - cropLines = len(self.contents) - LINES_BACKLOG + cropLines = len(self.contents) - LINES_LIMIT if cropLines > 0: self.contents = self.contents[cropLines:] if isDone: @@ -80,8 +101,6 @@ class InterpretorPanel(panel.Panel): panel.CURSES_LOCK.release() def handleKey(self, key): - # TODO: allow contents to be searched (with hilighting?) - isKeystrokeConsumed = True if uiTools.isSelectionKey(key): self.prompt() @@ -97,8 +116,6 @@ class InterpretorPanel(panel.Panel): return isKeystrokeConsumed def draw(self, width, height): - if not self.formats: self._initFormats() - # page title usageMsg = " (enter \"/help\" for usage or a blank line to stop)" if self.isInputMode else "" self.addstr(0, 0, "Control Interpretor%s:" % usageMsg, curses.A_STANDOUT) @@ -118,21 +135,10 @@ class InterpretorPanel(panel.Panel): cursor = xOffset for msg, formatEntry in entry: - format = self.formats.get(formatEntry, curses.A_NORMAL) + format = getFormat(formatEntry) self.addstr(drawLine, cursor, msg, format) cursor += len(msg) drawLine += 1 if drawLine >= height: break - def _initFormats(self): - self.formats[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") - self.formats[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") - self.formats[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") - self.formats[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") - self.formats[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") - self.formats[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") -

1 0

[arm/release] fix: prevent startup if can't connect to tor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d977dc8d965abf0cb8ebae527222cb48b8ca3cdb Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 08:23:56 2011 -0700 fix: prevent startup if can't connect to tor We've had a couple people confused because tor is running without a control port but when they start arm it provides the wizard, saying that tor's shut down. Making detached startup contingent on not having an active tor process to avoid this. --- src/starter.py | 8 ++++++-- src/util/torTools.py | 14 ++++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/starter.py b/src/starter.py index ff2f4a8..a2617f7 100644 --- a/src/starter.py +++ b/src/starter.py @@ -386,8 +386,12 @@ if __name__ == '__main__': msg = STANDARD_CFG_NOT_FOUND_MSG % configPath util.log.log(util.log.NOTICE, msg) - # when launching a prompt it doens't make sense to be without a tor instance - if launchPrompt: + # prevent arm from starting without a tor instance if... + # - we're launching a prompt + # - tor is running (otherwise it would be kinda confusing, "tor is running + # but why does arm say that it's shut down?") + + if launchPrompt or util.torTools.isTorRunning(): config.set("features.allowDetachedStartup", "false") # revises defaults to match user's configuration diff --git a/src/util/torTools.py b/src/util/torTools.py index 39cb176..5c1b1ad 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -345,6 +345,20 @@ def isVersion(myVersion, minVersion): return True # versions match (should have been caught above...) +def isTorRunning(): + """ + Simple check for if a tor process is running. If this can't be determined + then this returns False. + """ + + # suggestions welcome for making this more reliable + commandResults = sysTools.call("ps co command") + if commandResults: + for cmd in commandResults: + if cmd.strip() == "tor": return True + + return False + def getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being

1 0

[arm/release] Porting basic interpretor functionality to prompt
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 88bddc5de5d1b7bec947a6780a5874dadd723128 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 10:28:15 2011 -0700 Porting basic interpretor functionality to prompt Quick hack so the panel and prompt both share the same interpretor input/response logic. This makes the arm prompt now basically functional though gonna need to do some cleanup. --- src/cli/interpretorPanel.py | 160 +++++++++---------------------------------- src/util/torInterpretor.py | 132 +++++++++++++++++++++++++++++++++++- 2 files changed, 163 insertions(+), 129 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index b7c3fe0..b81fa85 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -5,13 +5,10 @@ information, tab completion, and other usability features. import curses -from util import enum, panel, textInput, torTools, uiTools +from util import enum, panel, textInput, torInterpretor, torTools, uiTools from TorCtl import TorCtl -Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") - -PROMPT = ">>> " USAGE_INFO = "to use this panel press enter" # limits used for cropping @@ -29,7 +26,7 @@ class InterpretorPanel(panel.Panel): # contents of the panel (oldest to newest), each line is a list of (msg, # format enum) tuples - self.contents = [[(PROMPT, Formats.PROMPT), (USAGE_INFO, Formats.USAGE)]] + self.contents = [[(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)]] def prompt(self): """ @@ -49,13 +46,32 @@ class InterpretorPanel(panel.Panel): validator = textInput.BasicValidator() validator = textInput.HistoryValidator(self.previousCommands, validator) - xOffset = len(PROMPT) + xOffset = len(torInterpretor.PROMPT) if len(self.contents) > self.maxY - 1: xOffset += 3 # offset for scrollbar - input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[Formats.INPUT], validator = validator) + input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[torInterpretor.Formats.INPUT], validator = validator) + input, isDone = input.strip(), False - isDone = self.handleQuery(input) + if not input: + isDone = True + else: + self.previousCommands.insert(0, input) + self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + + try: + inputEntry, outputEntry = torInterpretor.handleQuery(input) + except torInterpretor.InterpretorClosed: + isDone = True + + promptEntry = self.contents.pop() # removes old prompt entry + self.contents += inputEntry + self.contents += outputEntry + self.contents.append(promptEntry) + + # if too long then crop lines + cropLines = len(self.contents) - LINES_BACKLOG + if cropLines > 0: self.contents = self.contents[cropLines:] if isDone: self.isInputMode = False @@ -63,89 +79,6 @@ class InterpretorPanel(panel.Panel): panel.CURSES_LOCK.release() - def handleQuery(self, input): - """ - Processes the given input. Requests starting with a '/' are special - commands to the interpretor, and anything else is sent to the control port. - This returns a boolean to indicate if the interpretor should terminate or - not. - - Arguments: - input - user input to be processed - """ - - if not input or not input.strip(): return True - input = input.strip() - inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] - conn = torTools.getConn() - - # input falls into three general categories: - # - interpretor command which starts with a '/' - # - controller commands handled by torTools (this allows for caching, - # proper handling by the rest of arm, etc) - # - unrecognized controller command, this has the possability of confusing - # arm... - - if input.startswith("/"): - # interpretor command - inputEntry.append((input, Formats.INPUT_INTERPRETOR)) - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - - # TODO: add /help option - # TODO: add /write option - else: - # controller command - if " " in input: cmd, arg = input.split(" ", 1) - else: cmd, arg = input, "" - - inputEntry.append((cmd + " ", Formats.INPUT_CMD)) - if arg: inputEntry.append((arg, Formats.INPUT_ARG)) - - if cmd.upper() == "GETINFO": - try: - response = conn.getInfo(arg, suppressExc = False) - outputEntry.append((response, Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - elif cmd.upper() == "SETCONF": - if "=" in arg: - param, value = arg.split("=", 1) - - try: - conn.setOption(param.strip(), value.strip()) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - else: - # TODO: resets the attribute - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - else: - try: - response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) - - for entry in response: - # Response entries are tuples with the response code, body, and - # extra info. For instance: - # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) - - if len(entry) == 3: - outputEntry.append((entry[1], Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - - self.previousCommands.insert(0, input) - self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] - - promptEntry = self.contents.pop() # removes old prompt entry - self.contents += _splitOnNewlines(inputEntry) - self.contents += _splitOnNewlines(outputEntry) - self.contents.append(promptEntry) - - # if too long then crop lines - cropLines = len(self.contents) - LINES_BACKLOG - if cropLines > 0: self.contents = self.contents[cropLines:] - - return False - def handleKey(self, key): # TODO: allow contents to be searched (with hilighting?) @@ -193,40 +126,13 @@ class InterpretorPanel(panel.Panel): if drawLine >= height: break def _initFormats(self): - self.formats[Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") - self.formats[Formats.INPUT] = uiTools.getColor("cyan") - self.formats[Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") - self.formats[Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") - self.formats[Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") - self.formats[Formats.OUTPUT] = uiTools.getColor("blue") - self.formats[Formats.USAGE] = uiTools.getColor("cyan") - self.formats[Formats.HELP] = uiTools.getColor("magenta") - self.formats[Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") - -def _splitOnNewlines(entry): - """ - Splits a list of (msg, format) tuples on newlines into a list of lines. - - Arguments: - entry - list of display tuples - """ - - results, tmpLine = [], [] - entry = list(entry) # shallow copy - - while entry: - msg, format = entry.pop(0) - - if "\n" in msg: - msg, remainder = msg.split("\n", 1) - entry.insert(0, (remainder, format)) - - tmpLine.append((msg, format)) - results.append(tmpLine) - tmpLine = [] - else: - tmpLine.append((msg, format)) - - if tmpLine: results.append(tmpLine) - return results + self.formats[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + self.formats[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + self.formats[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + self.formats[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") + self.formats[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") + self.formats[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 9b6bff4..866495d 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -6,7 +6,10 @@ directly, history and tab completion. import readline # simply importing this provides history to raw_input -from util import enum +from util import enum, torTools + +PROMPT = ">>> " +Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE") @@ -21,6 +24,13 @@ ATTR_ENCODING = {Attr.BOLD: "1", Attr.UNDERLINE: "4", Attr.HILIGHT: "7"} CSI = "\x1B[%sm" RESET = CSI % "0" +class InterpretorClosed(Exception): + """ + Exception raised when the interpretor should be shut down. + """ + + pass + def format(msg, *attr): """ Simple terminal text formatting, using ANSI escape sequences from: @@ -60,7 +70,125 @@ def prompt(): prompt = format(">>> ", Color.GREEN, Attr.BOLD) input = "" + formatMap = {} # mapping of Format to Color and Attr enums + formatMap[Formats.PROMPT] = (Attr.BOLD, Color.GREEN) + formatMap[Formats.INPUT] = (Color.CYAN, ) + formatMap[Formats.INPUT_INTERPRETOR] = (Attr.BOLD, Color.MAGENTA) + formatMap[Formats.INPUT_CMD] = (Attr.BOLD, Color.GREEN) + formatMap[Formats.INPUT_ARG] = (Attr.BOLD, Color.CYAN) + formatMap[Formats.OUTPUT] = (Color.BLUE, ) + formatMap[Formats.USAGE] = (Color.CYAN, ) + formatMap[Formats.HELP] = (Color.MAGENTA, ) + formatMap[Formats.ERROR] = (Attr.BOLD, Color.RED) + while input != "/quit": input = raw_input(prompt) - print format("echoing back '%s'" % input, Color.BLUE) + + _, outputEntry = handleQuery(input) + + for line in outputEntry: + outputLine = "" + + for msg, msgFormat in line: + outputLine += format(msg, *formatMap[msgFormat]) + + print outputLine + +def handleQuery(input): + """ + Processes the given input. Requests starting with a '/' are special + commands to the interpretor, and anything else is sent to the control port. + This returns an input/output tuple, each entry being a list of lines, each + line having a list of (msg, format) tuples for the content to be displayed. + This raises a InterpretorClosed if the interpretor should be shut down. + + Arguments: + input - user input to be processed + """ + + input = input.strip() + inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] + conn = torTools.getConn() + + # input falls into three general categories: + # - interpretor command which starts with a '/' + # - controller commands handled by torTools (this allows for caching, + # proper handling by the rest of arm, etc) + # - unrecognized controller command, this has the possability of confusing + # arm... + + if input.startswith("/"): + # interpretor command + inputEntry.append((input, Formats.INPUT_INTERPRETOR)) + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + + # TODO: add /help option + # TODO: add /write option + else: + # controller command + if " " in input: cmd, arg = input.split(" ", 1) + else: cmd, arg = input, "" + + inputEntry.append((cmd + " ", Formats.INPUT_CMD)) + if arg: inputEntry.append((arg, Formats.INPUT_ARG)) + + if cmd.upper() == "GETINFO": + try: + response = conn.getInfo(arg, suppressExc = False) + outputEntry.append((response, Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + elif cmd.upper() == "SETCONF": + if "=" in arg: + param, value = arg.split("=", 1) + + try: + conn.setOption(param.strip(), value.strip()) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + else: + # TODO: resets the attribute + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + else: + try: + response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + + for entry in response: + # Response entries are tuples with the response code, body, and + # extra info. For instance: + # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) + + if len(entry) == 3: + outputEntry.append((entry[1], Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + + return (_splitOnNewlines(inputEntry), _splitOnNewlines(outputEntry)) + +def _splitOnNewlines(entry): + """ + Splits a list of (msg, format) tuples on newlines into a list of lines. + + Arguments: + entry - list of display tuples + """ + + results, tmpLine = [], [] + entry = list(entry) # shallow copy + + while entry: + msg, format = entry.pop(0) + + if "\n" in msg: + msg, remainder = msg.split("\n", 1) + entry.insert(0, (remainder, format)) + + tmpLine.append((msg, format)) + results.append(tmpLine) + tmpLine = [] + else: + tmpLine.append((msg, format)) + + if tmpLine: results.append(tmpLine) + return results

1 0