July 2016 - tor-commits - lists.torproject.org

[nyx/master] Replace ansi_to_output() with a working function
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit bf44422c22507010c9712151b913d8969f1f873d Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 25 10:43:32 2016 -0700 Replace ansi_to_output() with a working function Interpreter panel's ansi_to_output() is horribly overly simplistic. It formats the whole line with the attribute it starts with. For instance, /help output makes the whole thing bold rather than just the keyword. It also didn't recognize the color white. --- nyx/curses.py | 59 +++++++++++++++++++++++++++++++++++++++++++++++ nyx/panel/interpreter.py | 29 +++++++---------------- test/panel/interpreter.py | 9 -------- test/subwindow.py | 10 ++++++++ 4 files changed, 77 insertions(+), 30 deletions(-) diff --git a/nyx/curses.py b/nyx/curses.py index b33abd3..10ac4f0 100644 --- a/nyx/curses.py +++ b/nyx/curses.py @@ -18,6 +18,7 @@ if we want Windows support in the future too. curses_attr - curses encoded text attribute screen_size - provides the dimensions of our screen screenshot - dump of the present on-screen content + asci_to_curses - converts terminal formatting to curses halt - prevents further curses rendering during shutdown is_color_supported - checks if terminal supports color output @@ -88,6 +89,7 @@ import curses.ascii import curses.textpad import functools import os +import re import threading import stem.util.conf @@ -112,6 +114,7 @@ RED, GREEN, YELLOW, BLUE, CYAN, MAGENTA, BLACK, WHITE = list(Color) Attr = stem.util.enum.Enum('NORMAL', 'BOLD', 'UNDERLINE', 'HIGHLIGHT') NORMAL, BOLD, UNDERLINE, HIGHLIGHT = list(Attr) +ANSI_RE = re.compile('\x1B\[([0-9;]+)m') CURSES_COLORS = { Color.RED: curses.COLOR_RED, @@ -131,6 +134,18 @@ CURSES_ATTRIBUTES = { Attr.HIGHLIGHT: curses.A_STANDOUT, } +ASCI_TO_CURSES = { + '1': BOLD, + '30': BLACK, + '31': RED, + '32': GREEN, + '33': YELLOW, + '34': BLUE, + '35': MAGENTA, + '36': CYAN, + '37': WHITE, +} + DEFAULT_COLOR_ATTR = dict([(color, 0) for color in Color]) COLOR_ATTR = None @@ -460,6 +475,50 @@ def screenshot(): return '\n'.join(lines).rstrip() +def asci_to_curses(msg): + """ + Translates ANSI terminal escape sequences to curses formatting. + + :param str msg: string to be converted + + :returns: **list** series of (text, attr) tuples that's renderable by curses + """ + + entries, next_attr = [], () + match = ANSI_RE.search(msg) + + while match: + if match.start() > 0: + entries.append((msg[:match.start()], next_attr)) + + curses_attr = match.group(1).split(';') + new_attr = [ASCI_TO_CURSES[num] for num in curses_attr if num in ASCI_TO_CURSES] + + if '0' in curses_attr: + next_attr = tuple(new_attr) # includes a 'reset' + else: + combined_attr = list(next_attr) + + for attr in new_attr: + if attr in combined_attr: + continue + elif attr in Color: + # replace previous color with new one + combined_attr = filter(lambda attr: attr not in Color, combined_attr) + + combined_attr.append(attr) + + next_attr = tuple(combined_attr) + + msg = msg[match.end():] + match = ANSI_RE.search(msg) + + if msg: + entries.append((msg, next_attr)) + + return entries + + def halt(): """ Prevents further rendering of curses content while python's shutting down. diff --git a/nyx/panel/interpreter.py b/nyx/panel/interpreter.py index 7775028..1dcb0e8 100644 --- a/nyx/panel/interpreter.py +++ b/nyx/panel/interpreter.py @@ -7,12 +7,11 @@ import code import curses import nyx.controller import nyx.curses -import re import sys from cStringIO import StringIO from mock import patch -from nyx.curses import BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, BOLD, HIGHLIGHT, NORMAL +from nyx.curses import GREEN, MAGENTA, CYAN, BOLD, HIGHLIGHT from nyx import tor_controller, panel import stem @@ -22,25 +21,9 @@ import stem.interpreter.commands USAGE_INFO = 'to use this panel press enter' PROMPT = '>>> ' -ANSI_RE = re.compile('\\x1b\[([0-9;]*)m') -ATTRS = {'0': NORMAL, '1': BOLD, '30': BLACK, '31': RED, '32': GREEN, '33': YELLOW, '34': BLUE, '35': MAGENTA, '36': CYAN} BACKLOG_LIMIT = 100 -def ansi_to_output(line, attrs): - ansi_re = ANSI_RE.findall(line) - new_attrs = [] - - if line.find('\x1b[') == 0 and ansi_re: - for attr in ansi_re[0].split(';'): - new_attrs.append(ATTRS[attr]) - attrs = new_attrs - - line = ANSI_RE.sub('', line) - - return [(line, ) + tuple(attrs)], attrs - - def format_input(user_input): output = [(PROMPT, GREEN, BOLD)] @@ -123,10 +106,14 @@ class InterpreterPanel(panel.Panel): sys.stderr = old_stderr if response: self.prompt_line.insert(len(self.prompt_line) - 1, format_input(user_input)) - attrs = [] + for line in response.split('\n'): - line, attrs = ansi_to_output(line, attrs) - self.prompt_line.insert(len(self.prompt_line) - 1, line) + new_line = [] + + for text, attr in nyx.curses.asci_to_curses(line): + new_line.append([text] + list(attr)) + + self.prompt_line.insert(len(self.prompt_line) - 1, new_line) except stem.SocketClosed: is_done = True diff --git a/test/panel/interpreter.py b/test/panel/interpreter.py index 8283c5e..df42980 100644 --- a/test/panel/interpreter.py +++ b/test/panel/interpreter.py @@ -30,15 +30,6 @@ EXPECTED_SCROLLBAR_PANEL = ' |>>> to use this panel press enter' class TestInterpreter(unittest.TestCase): - def test_ansi_to_output(self): - ansi_text = '\x1b[32;1mthis is some sample text' - output_line, attrs = nyx.panel.interpreter.ansi_to_output(ansi_text, []) - - self.assertEqual('this is some sample text', output_line[0][0]) - self.assertEqual('Green', output_line[0][1]) - self.assertEqual('Bold', output_line[0][2]) - self.assertEqual(['Green', 'Bold'], attrs) - def test_format_input(self): user_input = 'getinfo' output = nyx.panel.interpreter.format_input(user_input) diff --git a/test/subwindow.py b/test/subwindow.py index 2df946e..db97970 100644 --- a/test/subwindow.py +++ b/test/subwindow.py @@ -14,6 +14,7 @@ import test from mock import call, Mock from test import require_curses +from nyx.curses import Color, Attr EXPECTED_ADDSTR_WRAP = """ 0123456789 0123456789 @@ -81,6 +82,15 @@ def _textbox(x = 0, text = ''): class TestCurses(unittest.TestCase): + def test_asci_to_curses(self): + self.assertEqual([], nyx.curses.asci_to_curses('')) + self.assertEqual([('hi!', ())], nyx.curses.asci_to_curses('hi!')) + self.assertEqual([('hi!', (Color.RED,))], nyx.curses.asci_to_curses('\x1b[31mhi!\x1b[0m')) + self.assertEqual([('boo', ()), ('hi!', (Color.RED, Attr.BOLD))], nyx.curses.asci_to_curses('boo\x1b[31;1mhi!\x1b[0m')) + self.assertEqual([('boo', ()), ('hi', (Color.RED,)), (' dami!', (Color.RED, Attr.BOLD))], nyx.curses.asci_to_curses('boo\x1b[31mhi\x1b[1m dami!\x1b[0m')) + self.assertEqual([('boo', ()), ('hi', (Color.RED,)), (' dami!', (Color.BLUE,))], nyx.curses.asci_to_curses('boo\x1b[31mhi\x1b[34m dami!\x1b[0m')) + self.assertEqual([('boo', ()), ('hi!', (Color.RED, Attr.BOLD)), ('and bye!', ())], nyx.curses.asci_to_curses('boo\x1b[31;1mhi!\x1b[0mand bye!')) + @require_curses def test_addstr(self): def _draw(subwindow):

1 0

[nyx/master] Split up and expand _handle_tab_completion() tests
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 1a80b5e7829d90205c343e7ab0ce8b712e792998 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jul 22 11:08:25 2016 -0700 Split up and expand _handle_tab_completion() tests Much better coverage along with more specialized tests. --- test/subwindow.py | 55 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 20 deletions(-) diff --git a/test/subwindow.py b/test/subwindow.py index 8eef938..b72aeb7 100644 --- a/test/subwindow.py +++ b/test/subwindow.py @@ -11,7 +11,7 @@ import nyx.curses import nyx.panel.interpreter import test -from mock import patch, call, Mock +from mock import call, Mock from test import require_curses @@ -68,13 +68,15 @@ EXPECTED_SCROLLBAR_BOTTOM = """ -+ """.strip() -NO_OP_HANDLER = lambda key, textbox: None +NO_OP_HANDLER = lambda textbox, key: key DIMENSIONS = (40, 80) -def _textbox(x = 0): +def _textbox(x = 0, text = ''): textbox = Mock() textbox.win.getyx.return_value = (0, x) + textbox.win.getmaxyx.return_value = (0, 40) # allow up to forty characters + textbox.gather.return_value = text return textbox @@ -160,7 +162,7 @@ class TestCurses(unittest.TestCase): self.assertEquals(call(0, 1), textbox.win.move.call_args) def test_handle_key_with_right_arrow_at_end(self): - textbox = _textbox(10) + textbox = _textbox(x = 10) textbox.gather.return_value = 'Sample Text' nyx.curses._handle_key(textbox, curses.KEY_RIGHT) @@ -196,20 +198,33 @@ class TestCurses(unittest.TestCase): nyx.curses._handle_history_key(mock_handle_key, [], textbox, curses.KEY_LEFT) self.assertTrue(mock_handle_key.called) - @patch('nyx.curses._handle_history_key') - def test_handle_tab_completion(self, mock_handle_history_key): - tab_completion_content = 'GETINFO version' + def test_handle_tab_completion_no_op(self): + tab_completion = lambda txt_input: ['GETINFO version'] + result = nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, _textbox(), ord('a')) + self.assertEqual(ord('a'), result) - textbox = Mock() - textbox.win.getyx.return_value = DIMENSIONS - textbox.win.getmaxyx.return_value = DIMENSIONS - textbox.win.addstr = Mock() - textbox.win.move = Mock() - tab_completion = Mock() - tab_completion.return_value = [tab_completion_content] - nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, textbox, 9) - self.assertTrue(textbox.win.clear.called) - expected_addstr_call = call(DIMENSIONS[0], 0, tab_completion_content) - self.assertEqual(expected_addstr_call, textbox.win.addstr.call_args) - expected_move_call = call(DIMENSIONS[0], len(tab_completion_content)) - self.assertTrue(expected_move_call, textbox.win.move.call_args) + def test_handle_tab_completion_no_matches(self): + tab_completion = lambda txt_input: [] + textbox = _textbox(text = 'GETINF') + result = nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, textbox, 9) + + self.assertEqual(None, result) # consumes input + self.assertFalse(textbox.win.addstr.called) + + def test_handle_tab_completion_single_match(self): + tab_completion = lambda txt_input: ['GETINFO version'] + textbox = _textbox(text = 'GETINF') + result = nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, textbox, 9) + + self.assertEqual(None, result) # consumes input + self.assertEquals(call(0, 15), textbox.win.move.call_args) # move cursor to end + self.assertEqual(call(0, 0, 'GETINFO version'), textbox.win.addstr.call_args) + + def test_handle_tab_completion_multiple_matches(self): + tab_completion = lambda txt_input: ['GETINFO version', 'GETINFO info/events'] + textbox = _textbox(text = 'GETINF') + result = nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, textbox, 9) + + self.assertEqual(None, result) # consumes input + self.assertEquals(call(0, 8), textbox.win.move.call_args) # move cursor to end + self.assertEqual(call(0, 0, 'GETINFO '), textbox.win.addstr.call_args)

1 0

[nyx/master] Rewrite backlog handling
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit b6908b1fa5092eab691b261e06be34df1e1d3eb7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 23 10:50:07 2016 -0700 Rewrite backlog handling Mutable function globals are code stink. They break thread safety and are just about never the right thing to do. The arm 1.4.5 HistoryValidator class was a lot closer to what we want... https://gitweb.torproject.org/nyx.git/tree/src/util/textInput.py?h=release#… Cleaning that up and replacing our _handle_history_key() with it. This is invisible to callers (they're both private helpers). Improving our tests along the way too. --- nyx/curses.py | 86 +++++++++++++++++++++++++------------------------------ test/subwindow.py | 48 +++++++++++++++---------------- 2 files changed, 63 insertions(+), 71 deletions(-) diff --git a/nyx/curses.py b/nyx/curses.py index ecc2644..b33abd3 100644 --- a/nyx/curses.py +++ b/nyx/curses.py @@ -150,8 +150,6 @@ SPECIAL_KEYS = { Dimensions = collections.namedtuple('Dimensions', ['width', 'height']) -HISTORY_DICT = {'selection_index': -1, 'custom_input': ''} - def conf_handler(key, value): if key == 'features.colorOverride': @@ -286,7 +284,7 @@ def str_input(x, y, initial_text = '', backlog = None, tab_completion = None): handler = _handle_key if backlog: - handler = functools.partial(_handle_history_key, handler, backlog) + handler = functools.partial(_TextBacklog(backlog)._handler, handler) if tab_completion: handler = functools.partial(_handle_tab_completion, handler, tab_completion) @@ -335,50 +333,6 @@ def _handle_key(textbox, key): return key -def _handle_history_key(next_handler, backlog, textbox, key): - """ - Allows user to select previous inputs when pressing up/down. - - :param func next_handler: handler to invoke after this - :param list backlog: backlog of all previous commands - :param Textbox textbox: current textbox context - :param int key: key pressed - - :returns: **None** if up/down is pressed, otherwise invokes next handler - """ - - global HISTORY_DICT - - if key in (curses.KEY_UP, curses.KEY_DOWN): - offset = 1 if key == curses.KEY_UP else -1 - new_selection = HISTORY_DICT['selection_index'] + offset - - new_selection = max(-1, new_selection) - new_selection = min(len(backlog) - 1, new_selection) - - if HISTORY_DICT['selection_index'] == new_selection: - return None - - if HISTORY_DICT['selection_index'] == -1: - HISTORY_DICT['custom_input'] = textbox.gather().strip() - - if new_selection == -1: - new_input = HISTORY_DICT['custom_input'] - else: - new_input = backlog[new_selection] - - y, _ = textbox.win.getyx() - _, max_x = textbox.win.getmaxyx() - textbox.win.clear() - textbox.win.addstr(y, 0, new_input[:max_x - 1]) - textbox.win.move(y, min(len(new_input), max_x - 1)) - - HISTORY_DICT['selection_index'] = new_selection - return None - - return next_handler(textbox, key) - - def _handle_tab_completion(next_handler, tab_completion, textbox, key): """ Allows user to tab complete commands if sufficient context is provided to @@ -419,6 +373,44 @@ def _handle_tab_completion(next_handler, tab_completion, textbox, key): return next_handler(textbox, key) +class _TextBacklog(object): + """ + History backlog that allows the :func:`~nyx.curses.str_input` function to + scroll through prior inputs when pressing the up and down arrow keys. + """ + + def __init__(self, backlog = []): + self._backlog = backlog # backlog contents, newest to oldest + self._selection = -1 # selected item, -1 if we're not on the backlog + self._custom_input = '' # field's input prior to selecting a backlog item + + def _handler(self, next_handler, textbox, key): + if key in (curses.KEY_UP, curses.KEY_DOWN): + if key == curses.KEY_UP: + new_selection = min(len(self._backlog) - 1, self._selection + 1) + else: + new_selection = max(-1, self._selection - 1) + + if self._selection == new_selection: + return None + + if self._selection == -1: + self._custom_input = textbox.gather().strip() # save custom input + + new_input = self._custom_input if new_selection == -1 else self._backlog[new_selection] + + y, _ = textbox.win.getyx() + _, max_x = textbox.win.getmaxyx() + textbox.win.clear() + textbox.win.addstr(y, 0, new_input[:max_x - 1]) + textbox.win.move(y, min(len(new_input), max_x - 1)) + self._selection = new_selection + + return None + + return next_handler(textbox, key) + + def curses_attr(*attributes): """ Provides encoding for the given curses text attributes. diff --git a/test/subwindow.py b/test/subwindow.py index b72aeb7..2df946e 100644 --- a/test/subwindow.py +++ b/test/subwindow.py @@ -174,30 +174,6 @@ class TestCurses(unittest.TestCase): def test_handle_key_when_resized(self): self.assertEqual(curses.ascii.BEL, nyx.curses._handle_key(_textbox(), 410)) - def test_handle_history_key(self): - backlog = ['GETINFO version'] - - textbox = Mock() - textbox.win.getyx.return_value = DIMENSIONS - self.assertIsNone(nyx.curses._handle_history_key(NO_OP_HANDLER, [], textbox, curses.KEY_UP)) - - textbox = Mock() - textbox.win.getyx.return_value = DIMENSIONS - textbox.win.getmaxyx.return_value = DIMENSIONS - textbox.win.addstr = Mock() - textbox.win.move = Mock() - nyx.curses._handle_history_key(NO_OP_HANDLER, backlog, textbox, curses.KEY_UP) - self.assertTrue(textbox.win.clear.called) - expected_addstr_call = call(DIMENSIONS[0], 0, backlog[0]) - self.assertEqual(expected_addstr_call, textbox.win.addstr.call_args) - expected_move_call = call(DIMENSIONS[0], len(backlog[0])) - self.assertEqual(expected_move_call, textbox.win.move.call_args) - - textbox = Mock() - mock_handle_key = Mock() - nyx.curses._handle_history_key(mock_handle_key, [], textbox, curses.KEY_LEFT) - self.assertTrue(mock_handle_key.called) - def test_handle_tab_completion_no_op(self): tab_completion = lambda txt_input: ['GETINFO version'] result = nyx.curses._handle_tab_completion(NO_OP_HANDLER, tab_completion, _textbox(), ord('a')) @@ -228,3 +204,27 @@ class TestCurses(unittest.TestCase): self.assertEqual(None, result) # consumes input self.assertEquals(call(0, 8), textbox.win.move.call_args) # move cursor to end self.assertEqual(call(0, 0, 'GETINFO '), textbox.win.addstr.call_args) + + def test_text_backlog_no_op(self): + backlog = nyx.curses._TextBacklog(['GETINFO version']) + textbox = _textbox() + + self.assertEqual(ord('a'), backlog._handler(NO_OP_HANDLER, textbox, ord('a'))) + self.assertFalse(textbox.win.addstr.called) + + def test_text_backlog_fills_history(self): + backlog = nyx.curses._TextBacklog(['GETINFO version']) + textbox = _textbox() + + self.assertEqual(None, backlog._handler(NO_OP_HANDLER, textbox, curses.KEY_UP)) + self.assertEqual(call(0, 0, 'GETINFO version'), textbox.win.addstr.call_args) + + def test_text_backlog_remembers_custom_input(self): + backlog = nyx.curses._TextBacklog(['GETINFO version']) + textbox = _textbox(text = 'hello') + + self.assertEqual(None, backlog._handler(NO_OP_HANDLER, textbox, curses.KEY_UP)) + self.assertEqual(call(0, 0, 'GETINFO version'), textbox.win.addstr.call_args) + + self.assertEqual(None, backlog._handler(NO_OP_HANDLER, textbox, curses.KEY_DOWN)) + self.assertEqual(call(0, 0, 'hello'), textbox.win.addstr.call_args)

1 0

[nyx/master] Reintroduce interpreter panel
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 0dea0d9336f91af7911fa316e327aded85c2e55f Merge: d9a84b0 2e3d989 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 31 16:22:10 2016 -0700 Reintroduce interpreter panel Part of Sambuddha's GSoC project, this is reintroducing the interpreter panel from the arm 1.4.5 release. Stem provides its own interpreter via the tor-prompt command, so this simply piggybacks on that. One minor gotcha is the event handling. If you run 'SETEVENTS' you'll break the bandwidth graph (among other things). Also, running /events will dump events nyx itself listens to. Unfortunately there's no easy way around this. If we allow direct control port access users will have a few ways of shooting us in the foot. This panel isn't overly well used so I doubt this will be much of an issue in practice, and if it becomes one we'll simply disable SETEVENTS. nyx/controller.py | 5 ++ nyx/curses.py | 219 ++++++++++++++++++++++++++++++++++++++++------ nyx/panel/__init__.py | 1 + nyx/panel/interpreter.py | 139 +++++++++++++++++++++++++++++ test/panel/__init__.py | 1 + test/panel/interpreter.py | 115 ++++++++++++++++++++++++ test/subwindow.py | 122 ++++++++++++++++++++++++++ 7 files changed, 576 insertions(+), 26 deletions(-)

1 0

[nyx/master] Minor drawing simplification
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 7088f7631ccc99ce1bd14945276aff1b20e27b9a Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jul 28 09:56:05 2016 -0700 Minor drawing simplification On reflection this is a tad shorter and nicer if we use enumerate(). --- nyx/panel/interpreter.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/nyx/panel/interpreter.py b/nyx/panel/interpreter.py index bc80bc3..c9d557d 100644 --- a/nyx/panel/interpreter.py +++ b/nyx/panel/interpreter.py @@ -66,7 +66,7 @@ class InterpreterPanel(panel.Panel): is_changed = self._scroller.handle_key(key, len(self._lines) + 1, page_height) if is_changed: - self.redraw(True) + self.redraw() def _execute_command(): self._is_input_mode = True @@ -83,12 +83,14 @@ class InterpreterPanel(panel.Panel): else: self._backlog.append(user_input) backlog_crop = len(self._backlog) - BACKLOG_LIMIT + if backlog_crop > 0: raise Exception(self._backlog) self._backlog = self._backlog[backlog_crop:] try: console_called = False + with patch('stem.interpreter.commands.code.InteractiveConsole.push') as console_push: response = self._interpreter.run_command(user_input) @@ -133,13 +135,9 @@ class InterpreterPanel(panel.Panel): self._x_offset = 2 subwindow.scrollbar(1, scroll, len(self._lines)) - y = 1 - scroll - - for line in self._lines + [PROMPT]: - x = self._x_offset + for i, line in enumerate(self._lines + [PROMPT]): + x, y = self._x_offset, i + 1 - scroll if y > 0: for text, attr in line: x = subwindow.addstr(x, y, text, *attr) - - y += 1

1 0

[nyx/master] No need to track 'last_content_height'
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 0ebf054b9f190d5718e2785867f18e31531d1787 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jul 27 10:16:29 2016 -0700 No need to track 'last_content_height' The interpreter panel doesn't do line wrapping. Until it does there's no need to track the last_content_height and do that hacky dance. The torrc panel only does because... well, it *does* line wrap. :P --- nyx/panel/interpreter.py | 43 ++++++++++++++++++++----------------------- test/panel/interpreter.py | 5 +---- 2 files changed, 21 insertions(+), 27 deletions(-) diff --git a/nyx/panel/interpreter.py b/nyx/panel/interpreter.py index 137ab9b..bc80bc3 100644 --- a/nyx/panel/interpreter.py +++ b/nyx/panel/interpreter.py @@ -51,20 +51,19 @@ class InterpreterPanel(panel.Panel): panel.Panel.__init__(self) self._is_input_mode = False - self._last_content_height = 0 self._x_offset = 0 self._scroller = nyx.curses.Scroller() self._backlog = [] + self._lines = [] controller = tor_controller() - self.autocompleter = stem.interpreter.autocomplete.Autocompleter(controller) - self.interpreter = stem.interpreter.commands.ControlInterpretor(controller) - self._lines = [] + self._autocompleter = stem.interpreter.autocomplete.Autocompleter(controller) + self._interpreter = stem.interpreter.commands.ControlInterpretor(controller) def key_handlers(self): def _scroll(key): page_height = self.get_height() - 1 - is_changed = self._scroller.handle_key(key, self._last_content_height, page_height) + is_changed = self._scroller.handle_key(key, len(self._lines) + 1, page_height) if is_changed: self.redraw(True) @@ -73,10 +72,10 @@ class InterpreterPanel(panel.Panel): self._is_input_mode = True while self._is_input_mode: - self.redraw(True) + self.redraw() _scroll(nyx.curses.KeyInput(curses.KEY_END)) page_height = self.get_height() - 1 - user_input = nyx.curses.str_input(4 + self._x_offset, self.get_top() + max(len(self._lines[-page_height:]), 1), '', list(reversed(self._backlog)), self.autocompleter.matches) + user_input = nyx.curses.str_input(4 + self._x_offset, self.get_top() + max(len(self._lines[-page_height:]), 1), '', list(reversed(self._backlog)), self._autocompleter.matches) user_input, is_done = user_input.strip(), False if not user_input: @@ -91,7 +90,8 @@ class InterpreterPanel(panel.Panel): try: console_called = False with patch('stem.interpreter.commands.code.InteractiveConsole.push') as console_push: - response = self.interpreter.run_command(user_input) + response = self._interpreter.run_command(user_input) + if console_push.called: console_called = True @@ -114,7 +114,7 @@ class InterpreterPanel(panel.Panel): if is_done: self._is_input_mode = False - self.redraw(True) + self.redraw() return ( nyx.panel.KeyHandler('enter', 'execute a command', _execute_command, key_func = lambda key: key.is_selection()), @@ -122,27 +122,24 @@ class InterpreterPanel(panel.Panel): ) def _draw(self, subwindow): - scroll = self._scroller.location(self._last_content_height, subwindow.height - 1) + if self._is_input_mode: + subwindow.addstr(0, 0, 'Control Interpreter (enter "/help" for usage or a blank line to stop):', HIGHLIGHT) + else: + subwindow.addstr(0, 0, 'Control Interpreter:', HIGHLIGHT) - if self._last_content_height > subwindow.height - 1: + scroll = self._scroller.location(len(self._lines) + 1, subwindow.height - 1) + + if len(self._lines) > subwindow.height - 2: self._x_offset = 2 - subwindow.scrollbar(1, scroll, self._last_content_height - 1) + subwindow.scrollbar(1, scroll, len(self._lines)) y = 1 - scroll for line in self._lines + [PROMPT]: x = self._x_offset - for text, attr in line: - x = subwindow.addstr(x, y, text, *attr) + if y > 0: + for text, attr in line: + x = subwindow.addstr(x, y, text, *attr) y += 1 - - subwindow.addstr(0, 0, ' ' * subwindow.width) - usage_msg = ' (enter \"/help\" for usage or a blank line to stop)' if self._is_input_mode else "" - subwindow.addstr(0, 0, 'Control Interpreter%s:' % usage_msg, HIGHLIGHT) - - new_content_height = y + scroll - 1 - if new_content_height != self._last_content_height: - self._last_content_height = new_content_height - self.redraw(True) diff --git a/test/panel/interpreter.py b/test/panel/interpreter.py index d036e32..4686fed 100644 --- a/test/panel/interpreter.py +++ b/test/panel/interpreter.py @@ -27,8 +27,6 @@ Control Interpreter: >>> to use this panel press enter """.strip() -EXPECTED_SCROLLBAR_PANEL = ' |>>> to use this panel press enter' - class TestInterpreter(unittest.TestCase): def test_format_input(self): @@ -75,10 +73,9 @@ class TestInterpreter(unittest.TestCase): self.assertIsInstance(panel._scroller, nyx.curses.Scroller) height = panel.get_height() - panel._last_content_height = height + panel._lines = [()] * height output_lines = test.render(panel._draw).content.split('\n') self.assertEqual(height, len(output_lines)) - self.assertEqual(EXPECTED_SCROLLBAR_PANEL, output_lines[1]) @patch('nyx.panel.interpreter.tor_controller') def test_key_handlers(self, tor_controller_mock):

1 0

[nyx/master] Fix torrc panel scrollbar
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit c4b2fed3e6860c1d0ccf6afb0851361a5994d11a Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jul 27 10:18:00 2016 -0700 Fix torrc panel scrollbar Oops, scroll values were incorrect causing the scrollbar to be off. --- nyx/panel/torrc.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/nyx/panel/torrc.py b/nyx/panel/torrc.py index 3682f7f..374d86c 100644 --- a/nyx/panel/torrc.py +++ b/nyx/panel/torrc.py @@ -109,7 +109,7 @@ class TorrcPanel(panel.Panel): ) def _draw(self, subwindow): - scroll = self._scroller.location(self._last_content_height - 1, subwindow.height - 1) + scroll = self._scroller.location(self._last_content_height, subwindow.height - 1) if self._torrc_content is None: subwindow.addstr(0, 1, self._torrc_load_error, RED, BOLD) @@ -126,7 +126,7 @@ class TorrcPanel(panel.Panel): if self._last_content_height > subwindow.height - 1: scroll_offset = 3 - subwindow.scrollbar(1, scroll, subwindow.height - 1) + subwindow.scrollbar(1, scroll, self._last_content_height - 1) y = 1 - scroll is_multiline = False # true if we're in the middle of a multiline torrc entry

1 0

[nyx/master] Make reset_listener methods private
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 1d8714a2b6805282f2d61fc4854f6f91a779c601 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jul 28 09:48:35 2016 -0700 Make reset_listener methods private No reason for these to be public. They're just used for our add_listener() call. --- nyx/panel/header.py | 4 ++-- nyx/panel/torrc.py | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index f08afd7..da13ff3 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -53,7 +53,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): self._message = None self._message_attr = [] - tor_controller().add_status_listener(self.reset_listener) + tor_controller().add_status_listener(self._reset_listener) def show_message(self, message = None, *attr, **kwargs): """ @@ -180,7 +180,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): _draw_status(subwindow, 0, self.get_height() - 1, nyx_controller.is_paused(), self._message, *self._message_attr) - def reset_listener(self, controller, event_type, _): + def _reset_listener(self, controller, event_type, _): self._update() if event_type == stem.control.State.CLOSED: diff --git a/nyx/panel/torrc.py b/nyx/panel/torrc.py index 374d86c..0bdaf2c 100644 --- a/nyx/panel/torrc.py +++ b/nyx/panel/torrc.py @@ -47,10 +47,10 @@ class TorrcPanel(panel.Panel): self._torrc_load_error = None controller = tor_controller() - controller.add_status_listener(self.reset_listener) - self.reset_listener(controller, State.RESET, None) + controller.add_status_listener(self._reset_listener) + self._reset_listener(controller, State.RESET, None) - def reset_listener(self, controller, event_type, _): + def _reset_listener(self, controller, event_type, _): """ Reloads and displays the torrc on tor reload (sighup) events. """

1 0

[nyx/master] Interpreter panel supports GETINFO requests
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 7e931e6047ab7e22ba8e08de58f54e7a687bd28d Author: Sambuddha Basu <sambuddhabasu1(a)gmail.com> Date: Sun Jun 19 18:16:41 2016 -0700 Interpreter panel supports GETINFO requests --- nyx/controller.py | 8 +++--- nyx/panel/interpreter.py | 72 ++++++++++++++++++++++++++++++++++++++++++++++++ nyx/panel/interpretor.py | 49 -------------------------------- nyx/tor_interpreter.py | 23 ++++++++++++++++ 4 files changed, 99 insertions(+), 53 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index c167c9a..54316a0 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -20,7 +20,7 @@ import nyx.panel.graph import nyx.panel.header import nyx.panel.log import nyx.panel.torrc -import nyx.panel.interpretor +import nyx.panel.interpreter import stem @@ -47,7 +47,7 @@ CONFIG = conf.config_dict('nyx', { 'features.panels.show.connection': True, 'features.panels.show.config': True, 'features.panels.show.torrc': True, - 'features.panels.show.interpretor': True, + 'features.panels.show.interpreter': True, 'features.redrawRate': 5, 'features.refreshRate': 5, 'features.confirmQuit': True, @@ -120,8 +120,8 @@ class Controller(object): if CONFIG['features.panels.show.torrc']: self._page_panels.append([nyx.panel.torrc.TorrcPanel()]) - if CONFIG['features.panels.show.interpretor']: - self._page_panels.append([nyx.panel.interpretor.InterpretorPanel()]) + if CONFIG['features.panels.show.interpreter']: + self._page_panels.append([nyx.panel.interpreter.InterpreterPanel()]) self.quit_signal = False self._page = 0 diff --git a/nyx/panel/interpreter.py b/nyx/panel/interpreter.py new file mode 100644 index 0000000..2769529 --- /dev/null +++ b/nyx/panel/interpreter.py @@ -0,0 +1,72 @@ +""" +Panel providing raw control port access with syntax hilighting, usage +information, tab completion, and other usability features. +""" + +import nyx.controller +import nyx.curses + +from nyx.curses import GREEN, CYAN, BOLD, HIGHLIGHT +from nyx.tor_interpreter import handle_query +from nyx import panel + + +USAGE_INFO = "to use this panel press enter" +PROMPT = ">>> " +PROMPT_LINE = [[(PROMPT, GREEN, BOLD), (USAGE_INFO, CYAN, BOLD)]] + +class InterpreterPanel(panel.Panel): + """ + Renders the interpreter panel with a prompt providing raw control port + access. + """ + + def __init__(self): + panel.Panel.__init__(self, 'interpreter') + + self._is_input_mode = False + + def key_handlers(self): + def _execute_command(): + self._is_input_mode = True + + while self._is_input_mode: + self.redraw(True) + user_input = nyx.curses.str_input(len(PROMPT), self.top + len(PROMPT_LINE)) + user_input, is_done = user_input.strip(), False + + if not user_input: + is_done = True + else: + input_entry, output_entry = handle_query(user_input) + input_entry.insert(0, (PROMPT, GREEN, BOLD)) + PROMPT_LINE.insert(len(PROMPT_LINE) - 1, input_entry) + for line in output_entry: + PROMPT_LINE.insert(len(PROMPT_LINE) - 1, [line]) + + if is_done: + self._is_input_mode = False + self.redraw(True) + + return ( + nyx.panel.KeyHandler('enter', 'execute a command', _execute_command, key_func = lambda key: key.is_selection()), + ) + + def draw(self, width, height): + usage_msg = " (enter \"/help\" for usage or a blank line to stop)" if self._is_input_mode else "" + self.addstr(0, 0, 'Control Interpreter%s:' % usage_msg, HIGHLIGHT) + + x_offset = 0 + draw_line = 1 + for entry in PROMPT_LINE: + cursor = x_offset + + msg, color, attr = None, None, None + for line in entry: + if len(line) == 2: + self.addstr(draw_line, cursor, line[0], line[1]) + elif len(line) == 3: + self.addstr(draw_line, cursor, line[0], line[1], line[2]) + cursor += len(line[0]) + + draw_line += 1 diff --git a/nyx/panel/interpretor.py b/nyx/panel/interpretor.py deleted file mode 100644 index 995490c..0000000 --- a/nyx/panel/interpretor.py +++ /dev/null @@ -1,49 +0,0 @@ -""" -Panel providing raw control port access with syntax hilighting, usage -information, tab completion, and other usability features. -""" - -import nyx.curses - -from nyx.curses import GREEN, CYAN, BOLD, HIGHLIGHT -from nyx import panel - - -USAGE_INFO = "to use this panel press enter" -PROMPT = ">>> " -PROMPT_LINE = [[(PROMPT, GREEN, BOLD), (USAGE_INFO, CYAN, BOLD)]] - -class InterpretorPanel(panel.Panel): - """ - Renders the current torrc or nyxrc with syntax highlighting in a scrollable - area. - """ - - def __init__(self): - panel.Panel.__init__(self, 'interpretor') - - self._is_input_mode = False - - def key_handlers(self): - def _execute_command(): - self._is_input_mode ^= True - self.redraw(True) - - return ( - nyx.panel.KeyHandler('enter', 'execute a command', _execute_command, key_func = lambda key: key.is_selection()), - ) - - def draw(self, width, height): - usage_msg = " (enter \"/help\" for usage or a blank line to stop)" if self._is_input_mode else "" - self.addstr(0, 0, 'Control Interpretor%s:' % usage_msg, HIGHLIGHT) - - x_offset = 0 - draw_line = 1 - for entry in PROMPT_LINE: - cursor = x_offset - - for msg, color, attr in entry: - self.addstr(draw_line, cursor, msg, color, attr) - cursor += len(msg) - - draw_line += 1 diff --git a/nyx/tor_interpreter.py b/nyx/tor_interpreter.py new file mode 100644 index 0000000..64d6554 --- /dev/null +++ b/nyx/tor_interpreter.py @@ -0,0 +1,23 @@ +from nyx.curses import GREEN, CYAN, BOLD, HIGHLIGHT +from nyx import tor_controller + + +def handle_query(user_input): + user_input = user_input.strip() + + input_entry, output_entry = [], [] + + if " " in user_input: cmd, arg = user_input.split(" ", 1) + else: cmd, arg = user_input, "" + + cmd = cmd.upper() + input_entry.append((cmd + " ", GREEN, BOLD)) + if arg: + input_entry.append((arg, CYAN, BOLD)) + + if cmd == "GETINFO": + resp = tor_controller().get_info(arg) + for line in resp.split('\n'): + output_entry.append((line, CYAN,)) + + return input_entry, output_entry

1 0

[nyx/master] Added InterpreterClosed exception Added /help and /quit commands
by atagar＠torproject.org 31 Jul '16

31 Jul '16

commit 8fbe69eacb90e4a133edd82a9ad4d9d055248c50 Author: Sambuddha Basu <sambuddhabasu1(a)gmail.com> Date: Sun Jun 19 19:21:36 2016 -0700 Added InterpreterClosed exception Added /help and /quit commands --- nyx/panel/interpreter.py | 15 +++++++++------ nyx/tor_interpreter.py | 43 ++++++++++++++++++++++++++++++++++--------- 2 files changed, 43 insertions(+), 15 deletions(-) diff --git a/nyx/panel/interpreter.py b/nyx/panel/interpreter.py index 2769529..2e3ec0d 100644 --- a/nyx/panel/interpreter.py +++ b/nyx/panel/interpreter.py @@ -7,7 +7,7 @@ import nyx.controller import nyx.curses from nyx.curses import GREEN, CYAN, BOLD, HIGHLIGHT -from nyx.tor_interpreter import handle_query +from nyx.tor_interpreter import handle_query, InterpreterClosed from nyx import panel @@ -38,11 +38,14 @@ class InterpreterPanel(panel.Panel): if not user_input: is_done = True else: - input_entry, output_entry = handle_query(user_input) - input_entry.insert(0, (PROMPT, GREEN, BOLD)) - PROMPT_LINE.insert(len(PROMPT_LINE) - 1, input_entry) - for line in output_entry: - PROMPT_LINE.insert(len(PROMPT_LINE) - 1, [line]) + try: + input_entry, output_entry = handle_query(user_input) + input_entry.insert(0, (PROMPT, GREEN, BOLD)) + PROMPT_LINE.insert(len(PROMPT_LINE) - 1, input_entry) + for line in output_entry: + PROMPT_LINE.insert(len(PROMPT_LINE) - 1, [line]) + except InterpreterClosed: + is_done = True if is_done: self._is_input_mode = False diff --git a/nyx/tor_interpreter.py b/nyx/tor_interpreter.py index 64d6554..bf94403 100644 --- a/nyx/tor_interpreter.py +++ b/nyx/tor_interpreter.py @@ -1,8 +1,19 @@ -from nyx.curses import GREEN, CYAN, BOLD, HIGHLIGHT +from nyx.curses import GREEN, CYAN, RED, MAGENTA, BOLD, HIGHLIGHT from nyx import tor_controller def handle_query(user_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: + user_input - user input to be processed + """ + user_input = user_input.strip() input_entry, output_entry = [], [] @@ -10,14 +21,28 @@ def handle_query(user_input): if " " in user_input: cmd, arg = user_input.split(" ", 1) else: cmd, arg = user_input, "" - cmd = cmd.upper() - input_entry.append((cmd + " ", GREEN, BOLD)) - if arg: - input_entry.append((arg, CYAN, BOLD)) + if cmd.startswith("/"): + input_entry.append((cmd, MAGENTA, BOLD)) + if cmd == "/quit": raise InterpreterClosed() + else: + output_entry.append(("Not yet implemented...", RED, BOLD)) + else: + cmd = cmd.upper() + input_entry.append((cmd + " ", GREEN, BOLD)) + if arg: + input_entry.append((arg, CYAN, BOLD)) - if cmd == "GETINFO": - resp = tor_controller().get_info(arg) - for line in resp.split('\n'): - output_entry.append((line, CYAN,)) + if cmd == "GETINFO": + resp = tor_controller().get_info(arg) + for line in resp.split('\n'): + output_entry.append((line, CYAN,)) return input_entry, output_entry + + +class InterpreterClosed(Exception): + """ + Exception raised when the interpreter should be shut down. + """ + + pass

1 0