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

[nyx/master] Drop request_redraw()
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit cfa6b91044bfcb62a543aaf267f377429a7dc1de Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 12:01:50 2016 -0800 Drop request_redraw() Really not needed in the one spot we use it. --- nyx/controller.py | 7 ------- nyx/popups.py | 2 +- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index aadad15..dc9f53b 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -375,13 +375,6 @@ class Controller: if force: self._last_drawn = current_time - def request_redraw(self): - """ - Requests that all content is redrawn when the interface is next rendered. - """ - - self._force_redraw = True - def set_msg(self, msg = None, attr = None, redraw = False): """ Sets the message displayed in the interfaces control panel. This uses our diff --git a/nyx/popups.py b/nyx/popups.py index c25b321..d6549a6 100644 --- a/nyx/popups.py +++ b/nyx/popups.py @@ -68,8 +68,8 @@ def popup_window(height = -1, width = -1, top = 0, left = 0, below_static = True return (None, 0, 0) def __exit__(self, exit_type, value, traceback): - nyx.controller.get_controller().request_redraw() panel.CURSES_LOCK.release() + nyx.controller.get_controller().redraw(True) return _Popup()

1 0

[nyx/master] Merge heartbeat_check() into header panel
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit 2013e771145df9ee845e4098011e308cafeb55d7 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 19:35:20 2016 -0800 Merge heartbeat_check() into header panel Our header panel already provides notices for file descriptor usage. Heartbeat tracking is pretty similar. --- nyx/controller.py | 25 ------------------------- nyx/header_panel.py | 14 ++++++++++++-- 2 files changed, 12 insertions(+), 27 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index 07cab4d..0f972b3 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -400,29 +400,6 @@ class Controller: self.quit_signal = True -def heartbeat_check(is_unresponsive): - """ - Logs if its been ten seconds since the last BW event. - - Arguments: - is_unresponsive - flag for if we've indicated to be responsive or not - """ - - controller = tor_controller() - last_heartbeat = controller.get_latest_heartbeat() - - if controller.is_alive(): - if not is_unresponsive and (time.time() - last_heartbeat) >= 10: - is_unresponsive = True - log.notice('Relay unresponsive (last heartbeat: %s)' % time.ctime(last_heartbeat)) - elif is_unresponsive and (time.time() - last_heartbeat) < 10: - # really shouldn't happen (meant Tor froze for a bit) - is_unresponsive = False - log.notice('Relay resumed') - - return is_unresponsive - - def start_nyx(stdscr): """ Main draw loop context. @@ -469,11 +446,9 @@ def start_nyx(stdscr): # main draw loop override_key = None # uses this rather than waiting on user input - is_unresponsive = False # flag for heartbeat responsiveness check while not control.quit_signal: display_panels = control.get_display_panels() - is_unresponsive = heartbeat_check(is_unresponsive) # sets panel visability diff --git a/nyx/header_panel.py b/nyx/header_panel.py index 4a0841e..bbc5ede 100644 --- a/nyx/header_panel.py +++ b/nyx/header_panel.py @@ -43,6 +43,7 @@ class HeaderPanel(panel.Panel, threading.Thread): self._pause_condition = threading.Condition() self._halt = False # terminates thread if true + self._reported_inactive = False tor_controller().add_status_listener(self.reset_listener) @@ -217,7 +218,8 @@ class HeaderPanel(panel.Panel, threading.Thread): """ x = self.addstr(y, x, 'Tor Disconnected', curses.A_BOLD, 'red') - self.addstr(y, x, vals.format(' ({last_heartbeat}, press r to reconnect)')) + last_heartbeat = time.strftime('%H:%M %m/%d/%Y', time.localtime(vals.last_heartbeat)) + self.addstr(y, x, ' (%s, press r to reconnect)' % last_heartbeat) def _draw_resource_usage(self, x, y, width, vals): """ @@ -388,6 +390,14 @@ class HeaderPanel(panel.Panel, threading.Thread): log_msg = msg('panel.header.fd_used_at_sixty_percent', percentage = fd_percent) log.log_once('fd_used_at_sixty_percent', log.NOTICE, log_msg) + if self._vals.is_connected: + if not self._reported_inactive and (time.time() - self._vals.last_heartbeat) >= 10: + self._reported_inactive = True + log.notice('Relay unresponsive (last heartbeat: %s)' % time.ctime(self._vals.last_heartbeat)) + elif self._reported_inactive and (time.time() - self._vals.last_heartbeat) < 10: + self._reported_inactive = False + log.notice('Relay resumed') + if previous_height != self.get_height(): # We're toggling between being a relay and client, causing the height # of this panel to change. Redraw all content so we don't get @@ -436,7 +446,7 @@ def get_sampling(last_sampling = None): 'retrieved': retrieved, 'is_connected': controller.is_alive(), 'connection_time': controller.connection_time(), - 'last_heartbeat': time.strftime('%H:%M %m/%d/%Y', time.localtime(controller.get_latest_heartbeat())), + 'last_heartbeat': controller.get_latest_heartbeat(), 'fingerprint': controller.get_info('fingerprint', 'Unknown'), 'nickname': controller.get_conf('Nickname', ''),

1 0

[nyx/master] Drop conn_reset_listener()
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit 16dc6d613c2ad7f9a982f351ff4a746d58f6deb3 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 19:05:06 2016 -0800 Drop conn_reset_listener() Moving the last remnents of the controller's status listener into other spots. --- nyx/controller.py | 12 ------------ nyx/header_panel.py | 5 ++++- nyx/settings/strings.cfg | 1 + nyx/util/tracker.py | 3 +++ 4 files changed, 8 insertions(+), 13 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index fcc6239..07cab4d 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -3,7 +3,6 @@ Main interface loop for nyx, periodically redrawing the screen and issuing user input to the proper panels. """ -import os import time import curses import threading @@ -20,7 +19,6 @@ import nyx.util.tracker import stem -from stem.control import State from stem.util import conf, log from nyx.util import panel, tor_controller, ui_tools @@ -111,11 +109,6 @@ def init_controller(stdscr, start_time): if CONFIG['features.panels.show.connection']: page_panels.append([nyx.connection_panel.ConnectionPanel(stdscr)]) - controller = tor_controller() - controller.add_status_listener(conn_reset_listener) - resolver = nyx.util.tracker.get_connection_tracker() - log.info('Operating System: %s, Connection Resolvers: %s' % (os.uname()[0], ', '.join(resolver._resolvers))) - # third page: config if CONFIG['features.panels.show.config']: @@ -430,11 +423,6 @@ def heartbeat_check(is_unresponsive): return is_unresponsive -def conn_reset_listener(controller, event_type, _): - if event_type == State.CLOSED: - log.notice('Tor control port closed') - - def start_nyx(stdscr): """ Main draw loop context. diff --git a/nyx/header_panel.py b/nyx/header_panel.py index 4eb0a84..4a0841e 100644 --- a/nyx/header_panel.py +++ b/nyx/header_panel.py @@ -15,7 +15,7 @@ import stem import nyx.controller import nyx.popups -from stem.control import Listener +from stem.control import Listener, State from stem.util import conf, log, proc, str_tools, system from nyx.util import msg, tor_controller, panel, tracker @@ -370,6 +370,9 @@ class HeaderPanel(panel.Panel, threading.Thread): def reset_listener(self, controller, event_type, _): self._update() + if event_type == State.CLOSED: + log.notice('Tor control port closed') + def _update(self): previous_height = self.get_height() self._vals = get_sampling(self._vals) diff --git a/nyx/settings/strings.cfg b/nyx/settings/strings.cfg index bfe375f..f669e43 100644 --- a/nyx/settings/strings.cfg +++ b/nyx/settings/strings.cfg @@ -37,6 +37,7 @@ msg.setup.unknown_event_types nyx doesn't recognize the following event types: { msg.setup.color_support_available Terminal color support detected and enabled msg.setup.color_support_unavailable Terminal color support unavailable +msg.tracker.available_resolvers Operating System: {os}, Connection Resolvers: {resolvers} msg.tracker.abort_getting_resources Failed three attempts to get process resource usage from {resolver}, {response} ({exc}) msg.tracker.abort_getting_port_usage Failed three attempts to determine the process using active ports ({exc}) msg.tracker.lookup_rate_increased connection lookup time increasing to {seconds} seconds per call diff --git a/nyx/util/tracker.py b/nyx/util/tracker.py index 8aa1181..2b2b155 100644 --- a/nyx/util/tracker.py +++ b/nyx/util/tracker.py @@ -47,6 +47,7 @@ Background tasks for gathering information about the tor process. """ import collections +import os import time import threading @@ -501,6 +502,8 @@ class ConnectionTracker(Daemon): else: self._resolvers = [CustomResolver.INFERENCE] + log.info('tracker.available_resolvers', os = os.uname()[0], resolvers = ', '.join(self._resolvers)) + def _task(self, process_pid, process_name): if self._custom_resolver: resolver = self._custom_resolver

1 0

[nyx/master] Halting trackers when tor disconnects
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit ea4d683b1c46da42b50251c0dcb57f860f4d8609 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 12:17:57 2016 -0800 Halting trackers when tor disconnects The connection tracker did this, but applying it to all trackers. --- nyx/controller.py | 19 +++---------------- nyx/log_panel.py | 8 +++++--- nyx/util/tracker.py | 3 +++ 3 files changed, 11 insertions(+), 19 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index dc9f53b..fcc6239 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -8,7 +8,6 @@ import time import curses import threading -import nyx.arguments import nyx.menu.menu import nyx.popups import nyx.header_panel @@ -38,7 +37,6 @@ def conf_handler(key, value): CONFIG = conf.config_dict('nyx', { - 'startup.events': 'N3', 'features.acsSupport': True, 'features.panels.show.graph': True, 'features.panels.show.log': True, @@ -104,8 +102,7 @@ def init_controller(stdscr, start_time): first_page_panels.append(nyx.graph_panel.GraphPanel(stdscr)) if CONFIG['features.panels.show.log']: - expanded_events = nyx.arguments.expand_events(CONFIG['startup.events']) - first_page_panels.append(nyx.log_panel.LogPanel(stdscr, expanded_events)) + first_page_panels.append(nyx.log_panel.LogPanel(stdscr)) if first_page_panels: page_panels.append(first_page_panels) @@ -434,18 +431,8 @@ def heartbeat_check(is_unresponsive): def conn_reset_listener(controller, event_type, _): - """ - Pauses connection resolution when tor's shut down, and resumes with the new - pid if started again. - """ - - resolver = nyx.util.tracker.get_connection_tracker() - - if resolver.is_alive(): - resolver.set_paused(event_type == State.CLOSED) - - if event_type == State.CLOSED: - log.notice('Tor control port closed') + if event_type == State.CLOSED: + log.notice('Tor control port closed') def start_nyx(stdscr): diff --git a/nyx/log_panel.py b/nyx/log_panel.py index 37e9e21..708a679 100644 --- a/nyx/log_panel.py +++ b/nyx/log_panel.py @@ -29,15 +29,16 @@ def conf_handler(key, value): CONFIG = conf.config_dict('nyx', { + 'attr.log_color': {}, + 'cache.log_panel.size': 1000, 'features.logFile': '', 'features.log.showDuplicateEntries': False, 'features.log.prepopulate': True, 'features.log.prepopulateReadLimit': 5000, 'features.log.maxRefreshRate': 300, 'features.log.regex': [], - 'cache.log_panel.size': 1000, 'msg.misc.event_types': '', - 'attr.log_color': {}, + 'startup.events': 'N3', }, conf_handler) # The height of the drawn content is estimated based on the last time we redrew @@ -61,11 +62,12 @@ class LogPanel(panel.Panel, threading.Thread): from tor's log file if it exists. """ - def __init__(self, stdscr, logged_events): + def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, 'log', 0) threading.Thread.__init__(self) self.setDaemon(True) + logged_events = nyx.arguments.expand_events(CONFIG['startup.events']) self._event_log = nyx.util.log.LogGroup(CONFIG['cache.log_panel.size'], group_by_day = True) self._event_types = nyx.util.log.listen_for_events(self._register_tor_event, logged_events) self._log_file = nyx.util.log.LogFileOutput(CONFIG['features.logFile']) diff --git a/nyx/util/tracker.py b/nyx/util/tracker.py index f218630..8aa1181 100644 --- a/nyx/util/tracker.py +++ b/nyx/util/tracker.py @@ -460,6 +460,9 @@ class Daemon(threading.Thread): self._process_pid = tor_pid self._process_name = tor_cmd if tor_cmd else 'tor' + elif event_type == stem.contorl.State.CLOSED: + self._process_pid = None + self._process_name = None def __enter__(self): self.start()

1 0

[nyx/master] Merge init_controller() into controller constructor
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit 5f975c93855f2d53a678eb701ea6229a0f6ece59 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 19:53:07 2016 -0800 Merge init_controller() into controller constructor Now that the init method just calls simple constructors we may as well do this in the Controller class. --- nyx/controller.py | 86 ++++++++++++++++++++----------------------------------- 1 file changed, 31 insertions(+), 55 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index 7b0a276..e35c929 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -76,54 +76,6 @@ def stop_controller(): return halt_thread -def init_controller(stdscr): - """ - Spawns the controller, and related panels for it. - - Arguments: - stdscr - curses window - """ - - global NYX_CONTROLLER - - # initializes the panels - - sticky_panels = [ - nyx.header_panel.HeaderPanel(stdscr), - LabelPanel(stdscr), - ] - - page_panels, first_page_panels = [], [] - - # first page: graph and log - if CONFIG['features.panels.show.graph']: - first_page_panels.append(nyx.graph_panel.GraphPanel(stdscr)) - - if CONFIG['features.panels.show.log']: - first_page_panels.append(nyx.log_panel.LogPanel(stdscr)) - - if first_page_panels: - page_panels.append(first_page_panels) - - # second page: connections - if CONFIG['features.panels.show.connection']: - page_panels.append([nyx.connection_panel.ConnectionPanel(stdscr)]) - - # third page: config - - if CONFIG['features.panels.show.config']: - page_panels.append([nyx.config_panel.ConfigPanel(stdscr)]) - - # fourth page: torrc - - if CONFIG['features.panels.show.torrc']: - page_panels.append([nyx.torrc_panel.TorrcPanel(stdscr)]) - - # initializes the controller - - NYX_CONTROLLER = Controller(stdscr, sticky_panels, page_panels) - - class LabelPanel(panel.Panel): """ Panel that just displays a single line of text. @@ -158,21 +110,43 @@ class Controller: Tracks the global state of the interface """ - def __init__(self, stdscr, sticky_panels, page_panels): + def __init__(self, stdscr): """ Creates a new controller instance. Panel lists are ordered as they appear, top to bottom on the page. Arguments: stdscr - curses window - sticky_panels - panels shown at the top of each page - page_panels - list of pages, each being a list of the panels on it """ - self.quit_signal = False self._screen = stdscr - self._sticky_panels = sticky_panels - self._page_panels = page_panels + + self._sticky_panels = [ + nyx.header_panel.HeaderPanel(stdscr), + LabelPanel(stdscr), + ] + + self._page_panels, first_page_panels = [], [] + + if CONFIG['features.panels.show.graph']: + first_page_panels.append(nyx.graph_panel.GraphPanel(stdscr)) + + if CONFIG['features.panels.show.log']: + first_page_panels.append(nyx.log_panel.LogPanel(stdscr)) + + if first_page_panels: + self._page_panels.append(first_page_panels) + + if CONFIG['features.panels.show.connection']: + self._page_panels.append([nyx.connection_panel.ConnectionPanel(stdscr)]) + + if CONFIG['features.panels.show.config']: + self._page_panels.append([nyx.config_panel.ConfigPanel(stdscr)]) + + if CONFIG['features.panels.show.torrc']: + self._page_panels.append([nyx.torrc_panel.TorrcPanel(stdscr)]) + + self.quit_signal = False self._page = 0 self._is_paused = False self._force_redraw = False @@ -408,7 +382,9 @@ def start_nyx(stdscr): stdscr - curses window """ - init_controller(stdscr) + global NYX_CONTROLLER + + NYX_CONTROLLER = Controller(stdscr) control = get_controller() if not CONFIG['features.acsSupport']:

1 0

[nyx/master] Header panel doesn't need the start time
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit d280b81cf55acbc792615613bd84096816a64ede Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Feb 10 19:45:01 2016 -0800 Header panel doesn't need the start time Argument's unused by the constructor. Guess just something that got lost in the shuffle. --- nyx/controller.py | 6 +++--- nyx/header_panel.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index 0f972b3..7b0a276 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -76,7 +76,7 @@ def stop_controller(): return halt_thread -def init_controller(stdscr, start_time): +def init_controller(stdscr): """ Spawns the controller, and related panels for it. @@ -89,7 +89,7 @@ def init_controller(stdscr, start_time): # initializes the panels sticky_panels = [ - nyx.header_panel.HeaderPanel(stdscr, start_time), + nyx.header_panel.HeaderPanel(stdscr), LabelPanel(stdscr), ] @@ -408,7 +408,7 @@ def start_nyx(stdscr): stdscr - curses window """ - init_controller(stdscr, CONFIG['start_time']) + init_controller(stdscr) control = get_controller() if not CONFIG['features.acsSupport']: diff --git a/nyx/header_panel.py b/nyx/header_panel.py index bbc5ede..0d6591a 100644 --- a/nyx/header_panel.py +++ b/nyx/header_panel.py @@ -34,7 +34,7 @@ class HeaderPanel(panel.Panel, threading.Thread): Top area containing tor settings and system information. """ - def __init__(self, stdscr, start_time): + def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, 'header', 0) threading.Thread.__init__(self) self.setDaemon(True)

1 0

[nyx/master] Replace stop_controller() with halt() method
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit 9555a8a14a3940df452d5640d82f6921e17066e5 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 11 20:37:10 2016 -0800 Replace stop_controller() with halt() method Feels a little better as a Controller method. --- nyx/controller.py | 36 ++++++++++++++++-------------------- nyx/starter.py | 9 +++++---- 2 files changed, 21 insertions(+), 24 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index e35c929..e143b49 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -56,26 +56,6 @@ def get_controller(): return NYX_CONTROLLER -def stop_controller(): - """ - Halts our Controller, providing back the thread doing so. - """ - - def halt_controller(): - control = get_controller() - - if control: - for panel_impl in control.get_daemon_panels(): - panel_impl.stop() - - for panel_impl in control.get_daemon_panels(): - panel_impl.join() - - halt_thread = threading.Thread(target = halt_controller) - halt_thread.start() - return halt_thread - - class LabelPanel(panel.Panel): """ Panel that just displays a single line of text. @@ -373,6 +353,22 @@ class Controller: 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(stdscr): """ diff --git a/nyx/starter.py b/nyx/starter.py index 6084d04..326bd82 100644 --- a/nyx/starter.py +++ b/nyx/starter.py @@ -265,10 +265,11 @@ def _shutdown_daemons(controller): Stops and joins on worker threads. """ - halt_threads = [ - nyx.controller.stop_controller(), - nyx.util.tracker.stop_trackers(), - ] + halt_threads = [nyx.util.tracker.stop_trackers()] + controller = nyx.controller.get_controller() + + if controller: + halt_threads.append(controller.halt()) for thread in halt_threads: thread.join()

1 0

[nyx/master] Drop unused Panel methods
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit ea87cf573b3a36f38a291ccd4157a1d7c43a78ed Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 14 16:06:06 2016 -0800 Drop unused Panel methods The get_left() and set_left() are just there to match the related methods for the top and bottom (... which are unused outside the Panel too). These too are completely unused so easy to pluck out. Dropping a couple other unused methods too. --- nyx/util/panel.py | 36 +----------------------------------- 1 file changed, 1 insertion(+), 35 deletions(-) diff --git a/nyx/util/panel.py b/nyx/util/panel.py index 283a16a..4a94133 100644 --- a/nyx/util/panel.py +++ b/nyx/util/panel.py @@ -209,13 +209,6 @@ class Panel(object): return self.parent - def is_visible(self): - """ - Provides if the panel's configured to be visible or not. - """ - - return self.visible - def set_visible(self, is_visible): """ Toggles if the panel is visible or not. @@ -325,13 +318,6 @@ class Panel(object): return self.pause_time - def get_top(self): - """ - Provides the position subwindows are placed at within its parent. - """ - - return self.top - def set_top(self, top): """ Changes the position where subwindows are placed within its parent. @@ -344,26 +330,6 @@ class Panel(object): self.top = top self.win = None - def get_left(self): - """ - Provides the left position where this subwindow is placed within its - parent. - """ - - return self.left - - def set_left(self, left): - """ - Changes the left position where this subwindow is placed within its parent. - - Arguments: - left - positioning of top within parent - """ - - if self.left != left: - self.left = left - self.win = None - def get_height(self): """ Provides the height used for subwindows (-1 if it isn't limited). @@ -467,7 +433,7 @@ class Panel(object): # skipped if not currently visible or activity has been halted - if not self.is_visible() or HALT_ACTIVITY: + if not self.visible or HALT_ACTIVITY: return # if the panel's completely outside its parent then this is a no-op

1 0

[nyx/master] Merge text_input into panel
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit bf58d639c25c5d7cf83ad840b68d716c59b81437 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 14 12:58:30 2016 -0800 Merge text_input into panel Our text_input module was primarily to support the control interpreter. We might re-introduce some of this in the future but for now only the BasicValidator is used by our codebase. --- nyx/util/__init__.py | 2 - nyx/util/panel.py | 80 +++++++++++++++++-- nyx/util/text_input.py | 213 ------------------------------------------------- 3 files changed, 75 insertions(+), 220 deletions(-) diff --git a/nyx/util/__init__.py b/nyx/util/__init__.py index e32a816..1bc3d71 100644 --- a/nyx/util/__init__.py +++ b/nyx/util/__init__.py @@ -17,8 +17,6 @@ from nyx.util import log __all__ = [ 'log', 'panel', - 'text_input', - 'tor_config', 'tracker', 'ui_tools', ] diff --git a/nyx/util/panel.py b/nyx/util/panel.py index bf16422..611a14d 100644 --- a/nyx/util/panel.py +++ b/nyx/util/panel.py @@ -9,7 +9,7 @@ import curses.ascii import curses.textpad from threading import RLock -from nyx.util import text_input, ui_tools +from nyx.util import ui_tools from stem.util import conf, log, str_tools @@ -32,6 +32,8 @@ SPECIAL_KEYS = { 'esc': 27, } +PASS = -1 + def conf_handler(key, value): if key == 'features.torrc.maxLineWrap': @@ -46,6 +48,76 @@ CONFIG = conf.config_dict('nyx', { HALT_ACTIVITY = False +class BasicValidator(object): + """ + 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 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.handle_key(key, textbox) + return key if result == PASS else result + + def handle_key(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. + + current_input = textbox.gather() + textbox.win.addstr(y, x + 1, current_input[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): + msg_length = len(textbox.gather()) + textbox.win.move(y, x) # reverts cursor movement during gather call + + if key == curses.KEY_END and msg_length > 0 and x < msg_length - 1: + # if we're in the content then move to the end + + textbox.win.move(y, msg_length - 1) + return None + elif key == curses.KEY_RIGHT and x >= msg_length - 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 + + class Panel(object): """ Wrapper for curses subwindows. This hides most of the ugliness in common @@ -555,7 +627,7 @@ class Panel(object): return x, y - def getstr(self, y, x, initial_text = '', text_format = None, max_width = None, validator = None): + def getstr(self, y, x, initial_text = '', text_format = None, max_width = 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 @@ -572,7 +644,6 @@ class Panel(object): initial_text - starting text in this field text_format - format used for the text max_width - maximum width for the text field - validator - custom TextInputValidator for handling keybindings """ if not text_format: @@ -610,8 +681,7 @@ class Panel(object): textbox = curses.textpad.Textbox(input_subwindow) - if not validator: - validator = text_input.BasicValidator() + validator = BasicValidator() textbox.win.attron(text_format) user_input = textbox.edit(lambda key: validator.validate(key, textbox)).strip() diff --git a/nyx/util/text_input.py b/nyx/util/text_input.py deleted file mode 100644 index 3172750..0000000 --- a/nyx/util/text_input.py +++ /dev/null @@ -1,213 +0,0 @@ -""" -Provides input validators that provide text input with various capabilities. -These can be chained together with the first matching validator taking -precidence. -""" - -import os -import curses - -PASS = -1 - - -class TextInputValidator: - """ - Basic interface for validators. Implementations should override the handle_key - method. - """ - - def __init__(self, next_validator = None): - self.next_validator = next_validator - - 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.handle_key(key, textbox) - - if result != PASS: - return result - elif self.next_validator: - return self.next_validator.validate(key, textbox) - else: - return key - - def handle_key(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 handle_key(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. - - current_input = textbox.gather() - textbox.win.addstr(y, x + 1, current_input[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): - msg_length = len(textbox.gather()) - textbox.win.move(y, x) # reverts cursor movement during gather call - - if key == curses.KEY_END and msg_length > 0 and x < msg_length - 1: - # if we're in the content then move to the end - - textbox.win.move(y, msg_length - 1) - return None - elif key == curses.KEY_RIGHT and x >= msg_length - 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 - - -class HistoryValidator(TextInputValidator): - """ - This intercepts the up and down arrow keys to scroll through a backlog of - previous commands. - """ - - def __init__(self, command_backlog = [], next_validator = None): - TextInputValidator.__init__(self, next_validator) - - # contents that can be scrolled back through, newest to oldest - - self.command_backlog = command_backlog - - # selected item from the backlog, -1 if we're not on a backlog item - - self.selection_index = -1 - - # the fields input prior to selecting a backlog item - - self.custom_input = '' - - def handle_key(self, key, textbox): - if key in (curses.KEY_UP, curses.KEY_DOWN): - offset = 1 if key == curses.KEY_UP else -1 - new_selection = self.selection_index + offset - - # constrains the new selection to valid bounds - - new_selection = max(-1, new_selection) - new_selection = min(len(self.command_backlog) - 1, new_selection) - - # skips if this is a no-op - - if self.selection_index == new_selection: - return None - - # saves the previous input if we weren't on the backlog - - if self.selection_index == -1: - self.custom_input = textbox.gather().strip() - - if new_selection == -1: - new_input = self.custom_input - else: - new_input = self.command_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_index = new_selection - return None - - return PASS - - -class TabCompleter(TextInputValidator): - """ - Provides tab completion based on the current input, finishing if there's only - a single match. This expects a functor that accepts the current input and - provides matches. - """ - - def __init__(self, completer, next_validator = None): - TextInputValidator.__init__(self, next_validator) - - # functor that accepts a string and gives a list of matches - - self.completer = completer - - def handle_key(self, key, textbox): - # Matches against the tab key. The ord('\t') is nine, though strangely none - # of the curses.KEY_*TAB constants match this... - - if key == 9: - current_contents = textbox.gather().strip() - matches = self.completer(current_contents) - new_input = None - - if len(matches) == 1: - # only a single match, fill it in - new_input = matches[0] - elif len(matches) > 1: - # looks for a common prefix we can complete - common_prefix = os.path.commonprefix(matches) # weird that this comes from path... - - if common_prefix != current_contents: - new_input = common_prefix - - # TODO: somehow display matches... this is not gonna be fun - - if new_input: - 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)) - - return None - - return PASS

1 0

[nyx/master] Drop unused no-op function
by atagar＠torproject.org 15 Feb '16

15 Feb '16

commit a157afc862a36f146595e98185ec8bc66996e5ea Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 11 22:15:07 2016 -0800 Drop unused no-op function --- nyx/util/panel.py | 8 -------- 1 file changed, 8 deletions(-) diff --git a/nyx/util/panel.py b/nyx/util/panel.py index 136fe85..bf16422 100644 --- a/nyx/util/panel.py +++ b/nyx/util/panel.py @@ -42,14 +42,6 @@ CONFIG = conf.config_dict('nyx', { 'features.maxLineWrap': 8, }, conf_handler) - -# tags used by addfstr - this maps to functor/argument combinations since the -# actual values (in the case of color attributes) might not yet be initialized - -def _no_op(arg): - return arg - - # prevents curses redraws if set HALT_ACTIVITY = False

1 0