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

[nyx/master] Move redraw method
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 66e34c28ca1c02a526c4a427e37955d25a3487cc Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 10:10:28 2016 -0700 Move redraw method Moving our redraw() method to the Interface with a couple simplifications... * The only time we ever call a panel's set_height() is for rendering, so that might as well just be a render() argument. * Since we started doing forced rendering by default 'features.refreshRate' and self._force_redraw are no longer doing anything. We may go back to this in the future but for now might as well just drop them it. --- nyx/__init__.py | 22 +++++++++++++++++++++- nyx/controller.py | 48 ------------------------------------------------ nyx/panel/__init__.py | 16 +++++----------- nyxrc.sample | 5 ----- 4 files changed, 26 insertions(+), 65 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index c5e24c1..91225b8 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -26,6 +26,7 @@ Tor curses monitoring application. |- is_paused - checks if the interface is paused |- set_paused - sets paused state | + |- redraw - renders our content |- quit - quits our application +- halt - stops daemon panels """ @@ -257,7 +258,6 @@ class Interface(object): if page_number != self._page: self._page = page_number - self._force_redraw = True self.header_panel().redraw() def page_count(self): @@ -330,6 +330,26 @@ class Interface(object): for panel_impl in self.get_page_panels(): panel_impl.redraw() + def redraw(self, force = True): + """ + Renders our displayed content. + + :param bool force: if **False** only redraws content if resized + """ + + # Curses may overly cache content without clearing here... + # https://trac.torproject.org/projects/tor/ticket/2830#comment:9 + + if force: + with nyx.curses.raw_screen() as stdscr: + stdscr.clear() + + occupied = 0 + + for panel in [self.header_panel()] + self.get_page_panels(): + panel.redraw(force = force, top = occupied) + occupied += panel.get_height() + def quit(self): """ Quits our application. diff --git a/nyx/controller.py b/nyx/controller.py index 7358383..6dd1b09 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -35,8 +35,6 @@ NYX_CONTROLLER = None def conf_handler(key, value): if key == 'features.redrawRate': return max(1, value) - elif key == 'features.refreshRate': - return max(0, value) CONFIG = conf.config_dict('nyx', { @@ -48,7 +46,6 @@ CONFIG = conf.config_dict('nyx', { 'features.panels.show.torrc': True, 'features.panels.show.interpreter': True, 'features.redrawRate': 5, - 'features.refreshRate': 5, 'features.confirmQuit': True, 'start_time': 0, }, conf_handler) @@ -105,8 +102,6 @@ class Controller(Interface): self._page_panels = [] self._header_panel = None - self._force_redraw = False - self._last_drawn = 0 NYX_CONTROLLER = self @@ -137,49 +132,6 @@ class Controller(Interface): def header_panel(self): return self._header_panel - def redraw(self, force = True): - """ - Redraws the displayed panel content. - - Arguments: - force - redraws regardless of if it's needed if true, otherwise ignores - the request when there aren't changes to be displayed - """ - - force |= self._force_redraw - self._force_redraw = False - - current_time = time.time() - - if CONFIG['features.refreshRate'] != 0: - if self._last_drawn + CONFIG['features.refreshRate'] <= current_time: - force = True - - display_panels = [self.header_panel()] + self.get_page_panels() - - occupied_content = 0 - - for panel_impl in display_panels: - panel_impl.set_top(occupied_content) - height = panel_impl.get_height() - - if height: - occupied_content += height - - # apparently curses may cache display contents unless we explicitely - # request a redraw here... - # https://trac.torproject.org/projects/tor/ticket/2830#comment:9 - - if force: - with nyx.curses.raw_screen() as stdscr: - stdscr.clear() - - for panel_impl in display_panels: - panel_impl.redraw(force = force) - - if force: - self._last_drawn = current_time - def start_nyx(): """ diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index 49c7e22..24ffadf 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -17,7 +17,6 @@ Panels consisting the nyx interface. | +- stop - stops triggering daemon actions | |- get_top - top position we're rendered into on the screen - |- set_top - sets top position within the screen |- get_height - height occupied by the panel | |- set_visible - toggles panel visiblity @@ -107,15 +106,6 @@ class Panel(object): return self._top - def set_top(self, top): - """ - Changes the position where we're rendered in the screen. - - :param int top: top position within the sceen - """ - - self._top = top - def get_height(self): """ Provides the height occupied by this panel. @@ -162,14 +152,18 @@ class Panel(object): return None - def redraw(self, force = True): + def redraw(self, force = True, top = None): """ Renders our panel's content to the screen. :param bool force: if **False** only redraws content if the panel's dimensions have changed + :param int top: position to render relative to the top of the screen """ + if top: + self._top = top + if not self._visible: return # not currently visible diff --git a/nyxrc.sample b/nyxrc.sample index 7bb300c..c9ff604 100644 --- a/nyxrc.sample +++ b/nyxrc.sample @@ -45,11 +45,6 @@ features.logFile # Seconds to wait on user input before refreshing content features.redrawRate 5 -# Rate (seconds) to periodically redraw the screen, disabled if zero. This -# shouldn't be necessary, but can correct issues if the terminal gets into a -# funky state. -features.refreshRate 5 - # Confirms promt to confirm when quiting if true features.confirmQuit true

1 0

[nyx/master] Reload signals caught wrong exception type
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 22c1ce6a0dcdde915f8347bfe60149e76cc1e37e Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Sep 9 10:59:43 2016 -0700 Reload signals caught wrong exception type Stem's signal() method raises ControllerErrors, not IOErrors. --- nyx/controller.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nyx/controller.py b/nyx/controller.py index 00bd504..4a3825f 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -413,7 +413,7 @@ def start_nyx(): if confirmation_key.match('x'): try: tor_controller().signal(stem.Signal.RELOAD) - except IOError as exc: + except stem.ControllerError as exc: log.error('Error detected when reloading tor: %s' % exc.strerror) elif key.match('h'): override_key = nyx.popups.show_help()

1 0

[nyx/master] Replace get_panels() with iterator
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 320baf839270e1e4c4d2d777fdc4f403272dd3d4 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 12:30:28 2016 -0700 Replace get_panels() with iterator This is only used internally, and makes sense that iterating over the interface would give you the panels. --- nyx/__init__.py | 40 ++++++++++++++++------------------------ nyx/controller.py | 12 ++++++------ 2 files changed, 22 insertions(+), 30 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 91225b8..dc4d3e5 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -19,7 +19,6 @@ Tor curses monitoring application. |- set_page - sets the page we're showing |- page_count - pages within our interface | - |- get_panels - provides all panels |- get_page_panels - provides panels on a page |- get_daemon_panels - provides daemon panels | @@ -269,20 +268,6 @@ class Interface(object): return len(self._page_panels) - def get_panels(self): - """ - Provides all panels in the interface. - - :returns: **list** with panels in the interface - """ - - all_panels = [self._header_panel] - - for page in self._page_panels: - all_panels += list(page) - - return all_panels - def get_page_panels(self, page_number = None): """ Provides panels belonging to a page, ordered top to bottom. @@ -302,7 +287,7 @@ class Interface(object): :returns: **list** of DaemonPanel in the interface """ - return [panel for panel in self.get_panels() if isinstance(panel, nyx.panel.DaemonPanel)] + return [panel for panel in self if isinstance(panel, nyx.panel.DaemonPanel)] def is_paused(self): """ @@ -324,11 +309,11 @@ class Interface(object): if is_pause != self._paused: self._paused = is_pause - for panel_impl in self.get_panels(): - panel_impl.set_paused(is_pause) + for panel in self: + panel.set_paused(is_pause) - for panel_impl in self.get_page_panels(): - panel_impl.redraw() + for panel in self.get_page_panels(): + panel.redraw() def redraw(self, force = True): """ @@ -365,15 +350,22 @@ class Interface(object): """ def halt_panels(): - for panel_impl in self.get_daemon_panels(): - panel_impl.stop() + for panel in self.get_daemon_panels(): + panel.stop() - for panel_impl in self.get_daemon_panels(): - panel_impl.join() + for panel in self.get_daemon_panels(): + panel.join() halt_thread = threading.Thread(target = halt_panels) halt_thread.start() return halt_thread + def __iter__(self): + yield self._header_panel + + for page in self._page_panels: + for panel in page: + yield panel + import nyx.panel diff --git a/nyx/controller.py b/nyx/controller.py index 6dd1b09..201dec4 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -151,8 +151,8 @@ def start_nyx(): # tells daemon panels to start - for panel_impl in interface.get_daemon_panels(): - panel_impl.start() + for panel in interface.get_daemon_panels(): + panel.start() # logs the initialization time @@ -167,8 +167,8 @@ def start_nyx(): # sets panel visability - for panel_impl in interface.get_panels(): - panel_impl.set_visible(panel_impl in display_panels) + for panel in interface: + panel.set_visible(panel in display_panels) interface.redraw() @@ -216,6 +216,6 @@ def start_nyx(): elif key.match('h'): override_key = nyx.popups.show_help() else: - for panel_impl in display_panels: - for keybinding in panel_impl.key_handlers(): + for panel in display_panels: + for keybinding in panel.key_handlers(): keybinding.handle(key)

1 0

[nyx/master] Move quit and halt methods
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 6a30efb8f330305ca8c354c36483e9b5b1bfe77d Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 13 10:45:38 2016 -0700 Move quit and halt methods Simply moving a couple of our methods used to terminate the application. --- nyx/__init__.py | 33 ++++++++++++++++++++++++++++++++- nyx/controller.py | 24 ++---------------------- 2 files changed, 34 insertions(+), 23 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 2ca58fe..c5e24c1 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -24,12 +24,16 @@ Tor curses monitoring application. |- get_daemon_panels - provides daemon panels | |- is_paused - checks if the interface is paused - +- set_paused - sets paused state + |- set_paused - sets paused state + | + |- quit - quits our application + +- halt - stops daemon panels """ import distutils.spawn import os import sys +import threading import stem.connection import stem.control @@ -228,6 +232,7 @@ class Interface(object): def __init__(self): self._page = 0 self._paused = False + self._quit = False def get_page(self): """ @@ -325,4 +330,30 @@ class Interface(object): for panel_impl in self.get_page_panels(): panel_impl.redraw() + def quit(self): + """ + Quits our application. + """ + + self._quit = True + + def halt(self): + """ + Stops curses panels in our interface. + + :returns: **threading.Thread** terminating daemons + """ + + def halt_panels(): + for panel_impl in self.get_daemon_panels(): + panel_impl.stop() + + for panel_impl in self.get_daemon_panels(): + panel_impl.join() + + halt_thread = threading.Thread(target = halt_panels) + halt_thread.start() + return halt_thread + + import nyx.panel diff --git a/nyx/controller.py b/nyx/controller.py index a50f2d4..7358383 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -7,7 +7,6 @@ user input to the proper panels. """ import time -import threading import nyx.curses import nyx.menu @@ -106,13 +105,13 @@ class Controller(Interface): self._page_panels = [] self._header_panel = None - self.quit_signal = False self._force_redraw = False self._last_drawn = 0 NYX_CONTROLLER = self self._header_panel = nyx.panel.header.HeaderPanel() + first_page_panels = [] if CONFIG['features.panels.show.graph']: first_page_panels.append(nyx.panel.graph.GraphPanel()) @@ -181,25 +180,6 @@ class Controller(Interface): if force: self._last_drawn = current_time - def quit(self): - self.quit_signal = True - - def halt(self): - """ - Halts curses panels, providing back the thread doing so. - """ - - def halt_panels(): - for panel_impl in self.get_daemon_panels(): - panel_impl.stop() - - for panel_impl in self.get_daemon_panels(): - panel_impl.join() - - halt_thread = threading.Thread(target = halt_panels) - halt_thread.start() - return halt_thread - def start_nyx(): """ @@ -230,7 +210,7 @@ def start_nyx(): override_key = None # uses this rather than waiting on user input - while not interface.quit_signal: + while not interface._quit: display_panels = [interface.header_panel()] + interface.get_page_panels() # sets panel visability

1 0

[nyx/master] Start Interface class, moving pause methods
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 89f8218031de2fce3863fe151c26320317ab4656 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 12 09:50:32 2016 -0700 Start Interface class, moving pause methods Starting a gradual migration of our Controller class into the Interface, rewritting this sucker as we go. Doing this as a Controller subclass so things continue to work as we move. --- nyx/__init__.py | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ nyx/controller.py | 53 ++++------------------------------------- 2 files changed, 75 insertions(+), 49 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 1ffd4b0..268c4ba 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -3,11 +3,27 @@ """ Tor curses monitoring application. + +:: + + nyx_interface - nyx interface singleton + tor_controller - tor connection singleton + + init_controller - initializes our connection to tor + expand_path - expands path with respect to our chroot + join - joins a series of strings up to a set length + msg - string from our configuration + + Interface - overall nyx interface + |- is_paused - checks if the interface is paused + |- pause_time - time when the interface was paused + +- set_paused - sets paused state """ import distutils.spawn import os import sys +import time import stem.connection import stem.control @@ -196,3 +212,58 @@ def msg(message, config, **attr): stem.util.log.notice(msg) return '' + + +class Interface(object): + """ + Overall state of the nyx interface. + """ + + def __init__(self): + self._paused = False + self._pause_time = None + + def is_paused(self): + """ + Checks if the interface is configured to be paused. + + :returns: **True** if the interface is paused, **False** otherwise + """ + + return self._paused + + def get_pause_time(self): + """ + Provides the time that we were last paused. + + :returns: **float** with the unix timestamp for when we were last paused, + **None** if not paused + """ + + return self._pause_time + + def set_paused(self, is_pause): + """ + Pauses or unpauses the interface. + + :param bool is_pause: suspends the interface if **True**, resumes it + otherwise + """ + + if is_pause != self._paused: + self._paused = is_pause + self._pause_time = time.time() if is_pause else None + + # Couple panels have their own pausing behavior. I'll later change this to + # a listener approach or someting else that's less hacky. + + for panel_impl in self.get_all_panels(): + if isinstance(panel_impl, nyx.panel.graph.GraphPanel) or isinstance(panel_impl, nyx.panel.log.LogPanel): + panel_impl.set_paused(is_pause) + + for panel_impl in self.get_display_panels(): + panel_impl.redraw() + + +import nyx.panel.graph +import nyx.panel.log diff --git a/nyx/controller.py b/nyx/controller.py index 4a3825f..42553b4 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -27,7 +27,7 @@ import stem from stem.util import conf, log from nyx.curses import BOLD -from nyx import tor_controller +from nyx import Interface, tor_controller NYX_CONTROLLER = None @@ -87,7 +87,7 @@ def input_prompt(msg, initial_value = ''): return user_input -class Controller(object): +class Controller(Interface): """ Tracks the global state of the interface """ @@ -98,12 +98,12 @@ class Controller(object): top to bottom on the page. """ + super(Controller, self).__init__() + self._page_panels = [] self._header_panel = None self.quit_signal = False self._page = 0 - self._paused = False - self._pause_time = -1 self._force_redraw = False self._last_drawn = 0 @@ -134,8 +134,6 @@ class Controller(object): self.quit_signal = False self._page = 0 - self._paused = False - self._pause_time = -1 self._force_redraw = False self._last_drawn = 0 @@ -184,49 +182,6 @@ class Controller(object): self.set_page((self._page - 1) % len(self._page_panels)) - def is_paused(self): - """ - Provides if the interface is configured to be paused or not. - - :returns: **True** if the interface is paused and **False** otherwise - """ - - return self._paused - - def set_paused(self, is_pause): - """ - Pauses or unpauses the interface. - - :param bool is_pause: suspends the interface if **True**, resumes it - otherwise - """ - - if is_pause != self._paused: - if is_pause: - self._pause_time = time.time() - - # Couple panels have their own pausing behavior. I'll later change this to - # a listener approach or someting else that's less hacky. - - for panel_impl in self.get_all_panels(): - if isinstance(panel_impl, nyx.panel.graph.GraphPanel) or isinstance(panel_impl, nyx.panel.log.LogPanel): - panel_impl.set_paused(is_pause) - - self._paused = is_pause - - for panel_impl in self.get_display_panels(): - panel_impl.redraw() - - def get_pause_time(self): - """ - Provides the time that we were last paused, returning -1 if we've never - been paused. - - :returns: **float** with the unix timestamp for when we were last paused - """ - - return self._pause_time - def header_panel(self): return self._header_panel

1 0

[nyx/master] Pressing 'x' to confirm reload didn't work
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 4c4f07704ed2832ea4fa022723fc36f46a9c1b09 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Sep 9 10:54:20 2016 -0700 Pressing 'x' to confirm reload didn't work We expected the confirmation_key to be an integer but it was actually a KeyInput, causing the check to always evaluate to false. --- nyx/controller.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nyx/controller.py b/nyx/controller.py index bf7a22d..00bd504 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -410,7 +410,7 @@ def start_nyx(): msg = "This will reset Tor's internal state. Are you sure (x again to confirm)?" confirmation_key = show_message(msg, BOLD, max_wait = 30) - if confirmation_key in (ord('x'), ord('X')): + if confirmation_key.match('x'): try: tor_controller().signal(stem.Signal.RELOAD) except IOError as exc:

1 0

[nyx/master] Move panel methods
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit af4562df66c5c6d3dc633cedf4368c88f463e8d0 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 13 10:25:19 2016 -0700 Move panel methods Pretty direct cut-and-paste with the exception of renaming get_display_panels(). --- nyx/__init__.py | 45 +++++++++++++++++++++++++++++++++++++++++++-- nyx/controller.py | 44 +++----------------------------------------- nyx/menu.py | 4 ++-- nyx/popups.py | 2 +- test/popups.py | 2 +- 5 files changed, 50 insertions(+), 47 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index c7a9b47..2ca58fe 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -19,6 +19,10 @@ Tor curses monitoring application. |- set_page - sets the page we're showing |- page_count - pages within our interface | + |- get_panels - provides all panels + |- get_page_panels - provides panels on a page + |- get_daemon_panels - provides daemon panels + | |- is_paused - checks if the interface is paused +- set_paused - sets paused state """ @@ -260,6 +264,41 @@ class Interface(object): return len(self._page_panels) + def get_panels(self): + """ + Provides all panels in the interface. + + :returns: **list** with panels in the interface + """ + + all_panels = [self._header_panel] + + for page in self._page_panels: + all_panels += list(page) + + return all_panels + + def get_page_panels(self, page_number = None): + """ + Provides panels belonging to a page, ordered top to bottom. + + :param int page_number: page to provide the panels of, current page if + **None** + + :returns: **list** of panels on that page + """ + + return list(self._page_panels[self._page if page_number is None else page_number]) + + def get_daemon_panels(self): + """ + Provides panels that are daemons. + + :returns: **list** of DaemonPanel in the interface + """ + + return [panel for panel in self.get_panels() if isinstance(panel, nyx.panel.DaemonPanel)] + def is_paused(self): """ Checks if the interface is configured to be paused. @@ -280,8 +319,10 @@ class Interface(object): if is_pause != self._paused: self._paused = is_pause - for panel_impl in self.get_all_panels(): + for panel_impl in self.get_panels(): panel_impl.set_paused(is_pause) - for panel_impl in self.get_display_panels(): + for panel_impl in self.get_page_panels(): panel_impl.redraw() + +import nyx.panel diff --git a/nyx/controller.py b/nyx/controller.py index 8e1f6f3..63aa13c 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -139,44 +139,6 @@ class Controller(Interface): def header_panel(self): return self._header_panel - def get_display_panels(self, page_number = None): - """ - Provides all panels belonging to a page and sticky content above it. This - is ordered they way they are presented (top to bottom) on the page. - - Arguments: - page_number - page number of the panels to be returned, the current - page if None - """ - - return_page = self._page if page_number is None else page_number - return list(self._page_panels[return_page]) if self._page_panels else [] - - def get_daemon_panels(self): - """ - Provides thread panels. - """ - - thread_panels = [] - - for panel_impl in self.get_all_panels(): - if isinstance(panel_impl, threading.Thread): - thread_panels.append(panel_impl) - - return thread_panels - - def get_all_panels(self): - """ - Provides all panels in the interface. - """ - - all_panels = [self._header_panel] - - for page in self._page_panels: - all_panels += list(page) - - return all_panels - def redraw(self, force = True): """ Redraws the displayed panel content. @@ -195,7 +157,7 @@ class Controller(Interface): if self._last_drawn + CONFIG['features.refreshRate'] <= current_time: force = True - display_panels = [self.header_panel()] + self.get_display_panels() + display_panels = [self.header_panel()] + self.get_page_panels() occupied_content = 0 @@ -274,11 +236,11 @@ def start_nyx(): override_key = None # uses this rather than waiting on user input while not interface.quit_signal: - display_panels = [interface.header_panel()] + interface.get_display_panels() + display_panels = [interface.header_panel()] + interface.get_page_panels() # sets panel visability - for panel_impl in interface.get_all_panels(): + for panel_impl in interface.get_panels(): panel_impl.set_visible(panel_impl in display_panels) interface.redraw() diff --git a/nyx/menu.py b/nyx/menu.py index 8ebaf4d..ebb8305 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -240,7 +240,7 @@ def _make_menu(): root_menu.add(_view_menu()) - for panel in interface.get_display_panels(): + for panel in interface.get_page_panels(): submenu = panel.submenu() if submenu: @@ -270,7 +270,7 @@ def _view_menu(): page_group = RadioGroup(interface.set_page, interface.get_page()) for i in range(interface.page_count()): - page_panels = interface.get_display_panels(page_number = i) + page_panels = interface.get_page_panels(page_number = i) label = ' / '.join([type(panel).__name__.replace('Panel', '') for panel in page_panels]) view_menu.add(RadioMenuItem(label, page_group, i)) diff --git a/nyx/popups.py b/nyx/popups.py index 5dd7c05..b52d95d 100644 --- a/nyx/popups.py +++ b/nyx/popups.py @@ -59,7 +59,7 @@ def show_help(): interface = nyx_interface() handlers = [] - for panel in reversed(interface.get_display_panels()): + for panel in reversed(interface.get_page_panels()): handlers += [handler for handler in panel.key_handlers() if handler.description] def _render(subwindow): diff --git a/test/popups.py b/test/popups.py index 4b12f33..361d15b 100644 --- a/test/popups.py +++ b/test/popups.py @@ -275,7 +275,7 @@ class TestPopups(unittest.TestCase): nyx.panel.KeyHandler('c', 'clear event log'), ) - nyx_interface_mock().get_display_panels.return_value = [header_panel, graph_panel, log_panel] + nyx_interface_mock().get_page_panels.return_value = [header_panel, graph_panel, log_panel] rendered = test.render(nyx.popups.show_help) self.assertEqual(EXPECTED_HELP_POPUP, rendered.content)

1 0

[nyx/master] Notify all panels of pausing/unpausing
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit f271985f7647e56b6737be689ceeb5329b1d492c Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 12 10:33:36 2016 -0700 Notify all panels of pausing/unpausing Initially I thought a listener pattern would make more sense, but just about all the panels need to be notified when we're paused or unpaused. As such adding a notification hook to the panel. This lets us drop get_pause_time() from the Interface since the two panels that care about this can now track it for themselves. --- nyx/__init__.py | 24 +----------------------- nyx/panel/__init__.py | 10 ++++++++++ nyx/panel/connection.py | 7 ++++++- nyx/panel/graph.py | 10 +++++----- nyx/panel/header.py | 10 +++++++--- nyx/panel/log.py | 8 ++++---- 6 files changed, 33 insertions(+), 36 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 268c4ba..4a031c7 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -16,14 +16,12 @@ Tor curses monitoring application. Interface - overall nyx interface |- is_paused - checks if the interface is paused - |- pause_time - time when the interface was paused +- set_paused - sets paused state """ import distutils.spawn import os import sys -import time import stem.connection import stem.control @@ -221,7 +219,6 @@ class Interface(object): def __init__(self): self._paused = False - self._pause_time = None def is_paused(self): """ @@ -232,16 +229,6 @@ class Interface(object): return self._paused - def get_pause_time(self): - """ - Provides the time that we were last paused. - - :returns: **float** with the unix timestamp for when we were last paused, - **None** if not paused - """ - - return self._pause_time - def set_paused(self, is_pause): """ Pauses or unpauses the interface. @@ -252,18 +239,9 @@ class Interface(object): if is_pause != self._paused: self._paused = is_pause - self._pause_time = time.time() if is_pause else None - - # Couple panels have their own pausing behavior. I'll later change this to - # a listener approach or someting else that's less hacky. for panel_impl in self.get_all_panels(): - if isinstance(panel_impl, nyx.panel.graph.GraphPanel) or isinstance(panel_impl, nyx.panel.log.LogPanel): - panel_impl.set_paused(is_pause) + panel_impl.set_paused(is_pause) for panel_impl in self.get_display_panels(): panel_impl.redraw() - - -import nyx.panel.graph -import nyx.panel.log diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index 5714db4..49c7e22 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -21,6 +21,7 @@ Panels consisting the nyx interface. |- get_height - height occupied by the panel | |- set_visible - toggles panel visiblity + |- set_paused - notified when interface pauses or unpauses |- key_handlers - keyboard input accepted by the panel |- submenu - submenu for the panel +- redraw - renders the panel content @@ -133,6 +134,15 @@ class Panel(object): self._visible = is_visible + def set_paused(self, is_pause): + """ + Notified when the interface pauses or unpauses. + + :param bool is_pause: suspended if **True**, resumed otherwise + """ + + pass + def key_handlers(self): """ Provides keyboard input this panel supports. diff --git a/nyx/panel/connection.py b/nyx/panel/connection.py index f8c3a7d..cabba2d 100644 --- a/nyx/panel/connection.py +++ b/nyx/panel/connection.py @@ -265,6 +265,7 @@ class ConnectionPanel(nyx.panel.DaemonPanel): self._entries = [] # last fetched display entries self._show_details = False # presents the details panel if true self._sort_order = CONFIG['features.connection.order'] + self._pause_time = 0 self._last_resource_fetch = -1 # timestamp of the last ConnectionResolver results used @@ -308,6 +309,10 @@ class ConnectionPanel(nyx.panel.DaemonPanel): self._sort_order = results self._entries = sorted(self._entries, key = lambda entry: [entry.sort_value(attr) for attr in self._sort_order]) + def set_paused(self, is_pause): + if is_pause: + self._pause_time = time.time() + def key_handlers(self): def _scroll(key): page_height = self.get_height() - 1 @@ -426,7 +431,7 @@ class ConnectionPanel(nyx.panel.DaemonPanel): selected, scroll = self._scroller.selection(lines, subwindow.height - details_offset - 1) if interface.is_paused(): - current_time = interface.get_pause_time() + current_time = self._pause_time() elif not controller.is_alive(): current_time = controller.connection_time() else: diff --git a/nyx/panel/graph.py b/nyx/panel/graph.py index 76d4bfa..5266e3f 100644 --- a/nyx/panel/graph.py +++ b/nyx/panel/graph.py @@ -498,6 +498,11 @@ class GraphPanel(nyx.panel.Panel): finally: nyx.controller.show_message() + def set_paused(self, is_pause): + if is_pause: + self._accounting_stats_paused = copy.copy(self._accounting_stats) + self._stats_paused = dict([(key, type(self._stats[key])(self._stats[key])) for key in self._stats]) + def key_handlers(self): def _pick_stats(): available_stats = sorted(self.stat_options()) @@ -546,11 +551,6 @@ class GraphPanel(nyx.panel.Panel): Submenu('Bounds', [RadioMenuItem(opt, bounds_group, opt) for opt in Bounds]), ]) - def set_paused(self, is_pause): - if is_pause: - self._accounting_stats_paused = copy.copy(self._accounting_stats) - self._stats_paused = dict([(key, type(self._stats[key])(self._stats[key])) for key in self._stats]) - def _draw(self, subwindow): if not self._displayed_stat: return diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 2165c3a..8b270b3 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -49,6 +49,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): self._last_width = nyx.curses.screen_size().width self._reported_inactive = False + self._pause_time = 0 self._message = None self._message_attr = [] @@ -115,6 +116,10 @@ class HeaderPanel(nyx.panel.DaemonPanel): if not self.is_wide(): self.show_message('Requesting a new identity', HIGHLIGHT, max_wait = 1) + def set_paused(self, is_pause): + if is_pause: + self._pause_time = time.time() + def key_handlers(self): def _reconnect(): if self._vals.is_connected: @@ -153,7 +158,6 @@ class HeaderPanel(nyx.panel.DaemonPanel): interface = nyx_interface() left_width = max(subwindow.width / 2, 77) if is_wide else subwindow.width right_width = subwindow.width - left_width - pause_time = interface.get_pause_time() if interface.is_paused() else None _draw_platform_section(subwindow, 0, 0, left_width, vals) @@ -163,7 +167,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): _draw_disconnected(subwindow, 0, 1, vals.last_heartbeat) if is_wide: - _draw_resource_usage(subwindow, left_width, 0, right_width, vals, pause_time) + _draw_resource_usage(subwindow, left_width, 0, right_width, vals, self._pause_time) if vals.is_relay: _draw_fingerprint_and_fd_usage(subwindow, left_width, 1, right_width, vals) @@ -172,7 +176,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): elif vals.is_connected: _draw_newnym_option(subwindow, left_width, 1, vals.newnym_wait) else: - _draw_resource_usage(subwindow, 0, 2, left_width, vals, pause_time) + _draw_resource_usage(subwindow, 0, 2, left_width, vals, self._pause_time) if vals.is_relay: _draw_fingerprint_and_fd_usage(subwindow, 0, 3, left_width, vals) diff --git a/nyx/panel/log.py b/nyx/panel/log.py index ca331ab..2cc41c7 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -189,6 +189,10 @@ class LogPanel(nyx.panel.DaemonPanel): except Exception as exc: raise IOError("unable to write to '%s': %s" % (path, exc)) + def set_paused(self, is_pause): + if is_pause: + self._event_log_paused = self._event_log.clone() + def key_handlers(self): def _scroll(key): page_height = self.get_height() - 1 @@ -256,10 +260,6 @@ class LogPanel(nyx.panel.DaemonPanel): ]), ]) - def set_paused(self, is_pause): - if is_pause: - self._event_log_paused = self._event_log.clone() - def _draw(self, subwindow): scroll = self._scroller.location(self._last_content_height, subwindow.height - 1)

1 0

[nyx/master] Finish merging Controller into the Interface
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 0a366d3c6d140d0a9f229e9decf69c3e42de7a6d Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 12:57:55 2016 -0700 Finish merging Controller into the Interface Last bit is moving the constructor in. This completes the shift from our old controller into the interface class. --- nyx/__init__.py | 55 +++++++++++++++++++++++++++++++++++--- nyx/controller.py | 79 +++---------------------------------------------------- 2 files changed, 56 insertions(+), 78 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index 973776d..a22e9f3 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -1,4 +1,4 @@ -# Copyright 2010-2016, Damian Johnson and The Tor Project +# Copyright 2009-2016, Damian Johnson and The Tor Project # See LICENSE for licensing information """ @@ -61,6 +61,16 @@ __all__ = [ 'tracker', ] +CONFIG = stem.util.conf.config_dict('nyx', { + 'features.panels.show.graph': True, + 'features.panels.show.log': True, + 'features.panels.show.connection': True, + 'features.panels.show.config': True, + 'features.panels.show.torrc': True, + 'features.panels.show.interpreter': True, +}) + +NYX_INTERFACE = None TOR_CONTROLLER = None BASE_DIR = os.path.sep.join(__file__.split(os.path.sep)[:-1]) DATA_DIR = os.path.expanduser('~/.nyx') @@ -115,8 +125,10 @@ def nyx_interface(): :returns: :class:`~nyx.Interface` controller """ - import nyx.controller - return nyx.controller.get_controller() + if NYX_INTERFACE is None: + Interface() # constructor sets NYX_INTERFACE + + return NYX_INTERFACE def tor_controller(): @@ -231,10 +243,40 @@ class Interface(object): """ def __init__(self): + global NYX_INTERFACE + self._page = 0 + self._page_panels = [] + self._header_panel = None self._paused = False self._quit = False + NYX_INTERFACE = self + + self._header_panel = nyx.panel.header.HeaderPanel() + first_page_panels = [] + + if CONFIG['features.panels.show.graph']: + first_page_panels.append(nyx.panel.graph.GraphPanel()) + + if CONFIG['features.panels.show.log']: + first_page_panels.append(nyx.panel.log.LogPanel()) + + if first_page_panels: + self._page_panels.append(first_page_panels) + + if CONFIG['features.panels.show.connection']: + self._page_panels.append([nyx.panel.connection.ConnectionPanel()]) + + if CONFIG['features.panels.show.config']: + self._page_panels.append([nyx.panel.config.ConfigPanel()]) + + if CONFIG['features.panels.show.torrc']: + self._page_panels.append([nyx.panel.torrc.TorrcPanel()]) + + if CONFIG['features.panels.show.interpreter']: + self._page_panels.append([nyx.panel.interpreter.InterpreterPanel()]) + def get_page(self): """ Provides the page we're showing. @@ -379,3 +421,10 @@ class Interface(object): import nyx.panel +import nyx.panel.config +import nyx.panel.connection +import nyx.panel.graph +import nyx.panel.header +import nyx.panel.interpreter +import nyx.panel.log +import nyx.panel.torrc diff --git a/nyx/controller.py b/nyx/controller.py index cb69082..85cf1fe 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -13,23 +13,13 @@ import nyx.menu import nyx.popups import nyx.panel -import nyx.panel.config -import nyx.panel.connection -import nyx.panel.graph -import nyx.panel.header -import nyx.panel.interpreter -import nyx.panel.log -import nyx.panel.torrc import stem from stem.util import conf, log from nyx.curses import BOLD -from nyx import Interface, tor_controller - - -NYX_CONTROLLER = None +from nyx import nyx_interface, tor_controller def conf_handler(key, value): @@ -39,31 +29,14 @@ def conf_handler(key, value): CONFIG = conf.config_dict('nyx', { 'features.acsSupport': True, - 'features.panels.show.graph': True, - 'features.panels.show.log': True, - 'features.panels.show.connection': True, - 'features.panels.show.config': True, - 'features.panels.show.torrc': True, - 'features.panels.show.interpreter': True, 'features.redrawRate': 5, 'features.confirmQuit': True, 'start_time': 0, }, conf_handler) -def get_controller(): - """ - Provides the nyx controller instance. - """ - - if NYX_CONTROLLER is None: - Controller() # constructor sets NYX_CONTROLLER - - return NYX_CONTROLLER - - def show_message(message = None, *attr, **kwargs): - return get_controller().header_panel().show_message(message, *attr, **kwargs) + return nyx_interface().header_panel().show_message(message, *attr, **kwargs) def input_prompt(msg, initial_value = ''): @@ -77,7 +50,7 @@ def input_prompt(msg, initial_value = ''): canceled """ - header_panel = get_controller().header_panel() + header_panel = nyx_interface().header_panel() header_panel.show_message(msg) user_input = nyx.curses.str_input(len(msg), header_panel.get_height() - 1, initial_value) @@ -86,56 +59,12 @@ def input_prompt(msg, initial_value = ''): return user_input -class Controller(Interface): - """ - Tracks the global state of the interface - """ - - def __init__(self): - """ - Creates a new controller instance. Panel lists are ordered as they appear, - top to bottom on the page. - """ - - global NYX_CONTROLLER - super(Controller, self).__init__() - - self._page_panels = [] - self._header_panel = None - - NYX_CONTROLLER = self - - self._header_panel = nyx.panel.header.HeaderPanel() - first_page_panels = [] - - if CONFIG['features.panels.show.graph']: - first_page_panels.append(nyx.panel.graph.GraphPanel()) - - if CONFIG['features.panels.show.log']: - first_page_panels.append(nyx.panel.log.LogPanel()) - - if first_page_panels: - self._page_panels.append(first_page_panels) - - if CONFIG['features.panels.show.connection']: - self._page_panels.append([nyx.panel.connection.ConnectionPanel()]) - - if CONFIG['features.panels.show.config']: - self._page_panels.append([nyx.panel.config.ConfigPanel()]) - - if CONFIG['features.panels.show.torrc']: - self._page_panels.append([nyx.panel.torrc.TorrcPanel()]) - - if CONFIG['features.panels.show.interpreter']: - self._page_panels.append([nyx.panel.interpreter.InterpreterPanel()]) - - def start_nyx(): """ Main draw loop context. """ - interface = get_controller() + interface = nyx_interface() if not CONFIG['features.acsSupport']: nyx.curses.disable_acs()

1 0

[nyx/master] Move header_panel method
by atagar＠torproject.org 16 Sep '16

16 Sep '16

commit 07432edae044bb5e71b16e2cd994ef9fbc89ad42 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 12:46:47 2016 -0700 Move header_panel method Moving our last method and dropping the get_* prefix from the other panel methods. --- nyx/__init__.py | 26 ++++++++++++++++++-------- nyx/controller.py | 7 ++----- nyx/menu.py | 4 ++-- nyx/popups.py | 2 +- test/popups.py | 2 +- 5 files changed, 24 insertions(+), 17 deletions(-) diff --git a/nyx/__init__.py b/nyx/__init__.py index dc4d3e5..973776d 100644 --- a/nyx/__init__.py +++ b/nyx/__init__.py @@ -19,8 +19,9 @@ Tor curses monitoring application. |- set_page - sets the page we're showing |- page_count - pages within our interface | - |- get_page_panels - provides panels on a page - |- get_daemon_panels - provides daemon panels + |- header_panel - provides the header panel + |- page_panels - provides panels on a page + |- daemon_panels - provides daemon panels | |- is_paused - checks if the interface is paused |- set_paused - sets paused state @@ -268,7 +269,16 @@ class Interface(object): return len(self._page_panels) - def get_page_panels(self, page_number = None): + def header_panel(self): + """ + Provides our interface's header. + + :returns: :class:`~nyx.panel.header.HeaderPanel` of our interface + """ + + return self._header_panel + + def page_panels(self, page_number = None): """ Provides panels belonging to a page, ordered top to bottom. @@ -280,7 +290,7 @@ class Interface(object): return list(self._page_panels[self._page if page_number is None else page_number]) - def get_daemon_panels(self): + def daemon_panels(self): """ Provides panels that are daemons. @@ -312,7 +322,7 @@ class Interface(object): for panel in self: panel.set_paused(is_pause) - for panel in self.get_page_panels(): + for panel in self.page_panels(): panel.redraw() def redraw(self, force = True): @@ -331,7 +341,7 @@ class Interface(object): occupied = 0 - for panel in [self.header_panel()] + self.get_page_panels(): + for panel in [self.header_panel()] + self.page_panels(): panel.redraw(force = force, top = occupied) occupied += panel.get_height() @@ -350,10 +360,10 @@ class Interface(object): """ def halt_panels(): - for panel in self.get_daemon_panels(): + for panel in self.daemon_panels(): panel.stop() - for panel in self.get_daemon_panels(): + for panel in self.daemon_panels(): panel.join() halt_thread = threading.Thread(target = halt_panels) diff --git a/nyx/controller.py b/nyx/controller.py index 201dec4..cb69082 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -129,9 +129,6 @@ class Controller(Interface): if CONFIG['features.panels.show.interpreter']: self._page_panels.append([nyx.panel.interpreter.InterpreterPanel()]) - def header_panel(self): - return self._header_panel - def start_nyx(): """ @@ -151,7 +148,7 @@ def start_nyx(): # tells daemon panels to start - for panel in interface.get_daemon_panels(): + for panel in interface.daemon_panels(): panel.start() # logs the initialization time @@ -163,7 +160,7 @@ def start_nyx(): override_key = None # uses this rather than waiting on user input while not interface._quit: - display_panels = [interface.header_panel()] + interface.get_page_panels() + display_panels = [interface.header_panel()] + interface.page_panels() # sets panel visability diff --git a/nyx/menu.py b/nyx/menu.py index ebb8305..4d5f61c 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -240,7 +240,7 @@ def _make_menu(): root_menu.add(_view_menu()) - for panel in interface.get_page_panels(): + for panel in interface.page_panels(): submenu = panel.submenu() if submenu: @@ -270,7 +270,7 @@ def _view_menu(): page_group = RadioGroup(interface.set_page, interface.get_page()) for i in range(interface.page_count()): - page_panels = interface.get_page_panels(page_number = i) + page_panels = interface.page_panels(page_number = i) label = ' / '.join([type(panel).__name__.replace('Panel', '') for panel in page_panels]) view_menu.add(RadioMenuItem(label, page_group, i)) diff --git a/nyx/popups.py b/nyx/popups.py index b52d95d..e2f0205 100644 --- a/nyx/popups.py +++ b/nyx/popups.py @@ -59,7 +59,7 @@ def show_help(): interface = nyx_interface() handlers = [] - for panel in reversed(interface.get_page_panels()): + for panel in reversed(interface.page_panels()): handlers += [handler for handler in panel.key_handlers() if handler.description] def _render(subwindow): diff --git a/test/popups.py b/test/popups.py index 361d15b..3e64914 100644 --- a/test/popups.py +++ b/test/popups.py @@ -275,7 +275,7 @@ class TestPopups(unittest.TestCase): nyx.panel.KeyHandler('c', 'clear event log'), ) - nyx_interface_mock().get_page_panels.return_value = [header_panel, graph_panel, log_panel] + nyx_interface_mock().page_panels.return_value = [header_panel, graph_panel, log_panel] rendered = test.render(nyx.popups.show_help) self.assertEqual(EXPECTED_HELP_POPUP, rendered.content)

1 0