- tor-commits - lists.torproject.org

[nyx/master] Fix nyx error logging
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 26ded909760b5e143e8a6bf061b8fa9b1d44ef39 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 18 11:33:43 2016 -0700 Fix nyx error logging Log messages at our error level weren't being displayed. This is because we logged them as 'NYX_ERROR' but expected 'NYX_ERR'. We were attempted to name our runlevels after tor but on reflection lets not - tor's names suck. Showing our actual runlevel names which are... * WARN => WARNING * ERR => ERROR --- nyx/arguments.py | 10 ++++------ nyx/log.py | 14 +++++++++++--- nyx/panel/log.py | 3 --- nyx/settings/attributes.cfg | 4 ++-- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/nyx/arguments.py b/nyx/arguments.py index e70278b..ad8ea4a 100644 --- a/nyx/arguments.py +++ b/nyx/arguments.py @@ -10,6 +10,7 @@ import getopt import os import nyx +import nyx.log import stem.util.connection @@ -215,12 +216,9 @@ def expand_events(flags): expanded_events, invalid_flags = set(), '' - tor_runlevels = ['DEBUG', 'INFO', 'NOTICE', 'WARN', 'ERR'] - nyx_runlevels = ['NYX_' + runlevel for runlevel in tor_runlevels] - for flag in flags: if flag == 'A': - return set(list(TOR_EVENT_TYPES) + nyx_runlevels + ['UNKNOWN']) + return set(list(TOR_EVENT_TYPES) + nyx.log.NYX_RUNLEVELS + ['UNKNOWN']) elif flag == 'X': return set() elif flag in 'DINWE12345': @@ -238,9 +236,9 @@ def expand_events(flags): runlevel_index = 4 if flag in 'DINWE': - runlevels = tor_runlevels[runlevel_index:] + runlevels = nyx.log.TOR_RUNLEVELS[runlevel_index:] elif flag in '12345': - runlevels = nyx_runlevels[runlevel_index:] + runlevels = nyx.log.NYX_RUNLEVELS[runlevel_index:] expanded_events.update(set(runlevels)) elif flag == 'U': diff --git a/nyx/log.py b/nyx/log.py index ec09c3f..2a60a9e 100644 --- a/nyx/log.py +++ b/nyx/log.py @@ -61,6 +61,7 @@ except ImportError: from stem.util.lru_cache import lru_cache TOR_RUNLEVELS = ['DEBUG', 'INFO', 'NOTICE', 'WARN', 'ERR'] +NYX_RUNLEVELS = ['NYX_DEBUG', 'NYX_INFO', 'NYX_NOTICE', 'NYX_WARNING', 'NYX_ERROR'] TIMEZONE_OFFSET = time.altzone if time.localtime()[8] else time.timezone @@ -133,9 +134,16 @@ def condense_runlevels(*events): tor_runlevels.append(r) events.remove(r) - if 'NYX_%s' % r in events: + if r == 'WARN': + nyx_runlevel = 'NYX_WARNING' + elif r == 'ERR': + nyx_runlevel = 'NYX_ERROR' + else: + nyx_runlevel = 'NYX_%s' % r + + if nyx_runlevel in events: nyx_runlevels.append(r) - events.remove('NYX_%s' % r) + events.remove(nyx_runlevel) tor_ranges = ranges(tor_runlevels) nyx_ranges = ranges(nyx_runlevels) @@ -180,7 +188,7 @@ def listen_for_events(listener, events): # accounts for runlevel naming difference tor_events = events.intersection(set(nyx.arguments.TOR_EVENT_TYPES.values())) - nyx_events = events.intersection(set(['NYX_%s' % runlevel for runlevel in TOR_RUNLEVELS])) + nyx_events = events.intersection(set(NYX_RUNLEVELS)) # adds events unrecognized by nyx if we're listening to the 'UNKNOWN' type diff --git a/nyx/panel/log.py b/nyx/panel/log.py index 3e8932d..278c633 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -378,9 +378,6 @@ class LogPanel(nyx.panel.DaemonPanel): self._register_event(nyx.log.LogEntry(event.arrived_at, event.type, msg)) def _register_nyx_event(self, record): - if record.levelname == 'WARNING': - record.levelname = 'WARN' - self._register_event(nyx.log.LogEntry(int(record.created), 'NYX_%s' % record.levelname, record.msg)) def _register_event(self, event): diff --git a/nyx/settings/attributes.cfg b/nyx/settings/attributes.cfg index fcc78f3..37e8ebc 100644 --- a/nyx/settings/attributes.cfg +++ b/nyx/settings/attributes.cfg @@ -48,8 +48,8 @@ attr.log_color ERR => Red attr.log_color NYX_DEBUG => Magenta attr.log_color NYX_INFO => Blue attr.log_color NYX_NOTICE => Green -attr.log_color NYX_WARN => Yellow -attr.log_color NYX_ERR => Red +attr.log_color NYX_WARNING => Yellow +attr.log_color NYX_ERROR => Red attr.log_color CIRC => Yellow attr.log_color BW => Cyan

1 0

[nyx/master] Draw helper for status message
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 68cb4ab6a854d41aab575c5f0ac934aa263b6444 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 12:52:52 2016 -0700 Draw helper for status message Just a small helper so this can be uniform with the rest. --- nyx/panel/header.py | 24 ++++++++++++++++-------- test/panel/header.py | 10 ++++++++++ 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 84b4b38..115bd3b 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -56,7 +56,7 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): self._reported_inactive = False self._message = None - self._message_attr = None + self._message_attr = [] tor_controller().add_status_listener(self.reset_listener) @@ -197,13 +197,7 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): _draw_fingerprint_and_fd_usage(subwindow, 0, 3, left_width, vals) _draw_flags(subwindow, 0, 4, vals.flags) - if self._message: - subwindow.addstr(0, subwindow.height - 1, self._message, *self._message_attr) - elif not self.is_paused(): - controller = nyx.controller.get_controller() - subwindow.addstr(0, subwindow.height - 1, 'page %i / %i - m: menu, p: pause, h: page help, q: quit' % (controller.get_page() + 1, controller.get_page_count())) - else: - subwindow.addstr(0, subwindow.height - 1, 'Paused', HIGHLIGHT) + _draw_status(subwindow, 0, subwindow.height - 1, self.is_paused(), self._message, *self._message_attr) def run(self): """ @@ -544,3 +538,17 @@ def _draw_newnym_option(subwindow, x, y, newnym_wait): else: plural = 's' if newnym_wait > 1 else '' subwindow.addstr(x, y, 'building circuits, available again in %i second%s' % (newnym_wait, plural)) + + +def _draw_status(subwindow, x, y, is_paused, message, *attr): + """ + Provides general usage information or a custom message. + """ + + if message: + subwindow.addstr(x, y, message, *attr) + elif not is_paused: + controller = nyx.controller.get_controller() + subwindow.addstr(x, y, 'page %i / %i - m: menu, p: pause, h: page help, q: quit' % (controller.get_page() + 1, controller.get_page_count())) + else: + subwindow.addstr(x, y, 'Paused', HIGHLIGHT) diff --git a/test/panel/header.py b/test/panel/header.py index e601f00..58f700c 100644 --- a/test/panel/header.py +++ b/test/panel/header.py @@ -275,3 +275,13 @@ class TestHeader(unittest.TestCase): self.assertEqual("press 'n' for a new identity", test.render(nyx.panel.header._draw_newnym_option, 0, 0, 0).content) self.assertEqual('building circuits, available again in 1 second', test.render(nyx.panel.header._draw_newnym_option, 0, 0, 1).content) self.assertEqual('building circuits, available again in 5 seconds', test.render(nyx.panel.header._draw_newnym_option, 0, 0, 5).content) + + @require_curses + @patch('nyx.controller.get_controller') + def test_draw_status(self, nyx_controller_mock): + nyx_controller_mock().get_page.return_value = 1 + nyx_controller_mock().get_page_count.return_value = 4 + + self.assertEqual('page 2 / 4 - m: menu, p: pause, h: page help, q: quit', test.render(nyx.panel.header._draw_status, 0, 0, False, None).content) + self.assertEqual('Paused', test.render(nyx.panel.header._draw_status, 0, 0, True, None).content) + self.assertEqual('pepperjack is wonderful!', test.render(nyx.panel.header._draw_status, 0, 0, False, 'pepperjack is wonderful!').content)

1 0

[nyx/master] Initialize header to a proper width
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 95febabba28fac36d48d7f4e0c58a661de37ebe5 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 13:01:50 2016 -0700 Initialize header to a proper width Using the actual screen size when initializing rather than a hardcoded value. This should prevent things from jumping around at startup on smaller monitors. --- nyx/panel/header.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 115bd3b..164929b 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -18,6 +18,7 @@ import stem.util.str_tools import stem.util.system import nyx.controller +import nyx.curses import nyx.panel import nyx.popups import nyx.tracker @@ -50,7 +51,7 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): self._vals = Sampling.create() - self._last_width = 100 + self._last_width = nyx.curses.screen_size()[0] self._pause_condition = threading.Condition() self._halt = False # terminates thread if true self._reported_inactive = False

1 0

[nyx/master] Always redraw header when updating
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 2b67c9f4d97b8d232ec3b09f0dde9794cc5c18df Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Apr 16 13:28:31 2016 -0700 Always redraw header when updating When we update our stats we always want to redraw. Kinda obvious, and little reason not to. In practice we were *never* calling forced redraws in this method because the previous_height check was always true (since we fetched the 'previous' at the same time as the 'current'). --- nyx/panel/header.py | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 4e4f922..84b4b38 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -239,7 +239,6 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): log.notice('Tor control port closed') def _update(self): - previous_height = self.get_height() self._vals = Sampling.create(self._vals) if self._vals.fd_used and self._vals.fd_limit != -1: @@ -261,14 +260,7 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): 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 - # overlapping content. - - nyx.controller.get_controller().redraw() - else: - self.redraw(True) # just need to redraw ourselves + self.redraw(True) class Sampling(object):

1 0

[nyx/master] Show notice when we're attempting to reconnect to tor
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 29a4653b380f25b70293339c6587949c645a950a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 18 11:42:01 2016 -0700 Show notice when we're attempting to reconnect to tor Tor takes a while before it accepts control connections. If you tell nyx to reconnect right after restarting tor it can hang for upward of thirty seconds. Showing a message to at least give a visual que that this is going on. --- nyx/panel/header.py | 1 + 1 file changed, 1 insertion(+) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 6551800..897ffbc 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -137,6 +137,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): return controller = tor_controller() + self.show_message('Reconnecting...', HIGHLIGHT) try: try:

1 0

[nyx/master] Drop most Panel constructor arguments
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 5199380f4aeda3b763bc3077c713cb0f51846249 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 18:10:51 2016 -0700 Drop most Panel constructor arguments The location and dimension arguments were only around for popups. Now that those use the new nyx.curses functions no need to keep them around. --- nyx/panel/__init__.py | 14 +++++++------- nyx/panel/connection.py | 2 +- nyx/panel/header.py | 2 +- nyx/panel/log.py | 2 +- nyx/panel/torrc.py | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index 86e64ac..39b8f85 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -166,7 +166,7 @@ class Panel(object): redraw(). """ - def __init__(self, name, top = 0, left = 0, height = -1, width = -1): + def __init__(self, name): """ Creates a durable wrapper for a curses subwindow in the given parent. @@ -188,10 +188,10 @@ class Panel(object): self.paused = False self.pause_time = -1 - self.top = top - self.left = left - self.height = height - self.width = width + self.top = 0 + self.left = 0 + self.height = -1 + self.width = -1 # The panel's subwindow instance. This is made available to implementors # via their draw method and shouldn't be accessed directly. @@ -714,8 +714,8 @@ class Panel(object): class DaemonPanel(Panel, threading.Thread): - def __init__(self, name, top = 0, left = 0, height = -1, width = -1, update_rate = 10): - Panel.__init__(self, name, top, left, height, width) + def __init__(self, name, update_rate): + Panel.__init__(self, name) threading.Thread.__init__(self) self.setDaemon(True) diff --git a/nyx/panel/connection.py b/nyx/panel/connection.py index b75376d..863be22 100644 --- a/nyx/panel/connection.py +++ b/nyx/panel/connection.py @@ -262,7 +262,7 @@ class ConnectionPanel(nyx.panel.DaemonPanel): """ def __init__(self): - nyx.panel.DaemonPanel.__init__(self, 'connections', update_rate = UPDATE_RATE) + nyx.panel.DaemonPanel.__init__(self, 'connections', UPDATE_RATE) self._scroller = nyx.curses.CursorScroller() self._entries = [] # last fetched display entries diff --git a/nyx/panel/header.py b/nyx/panel/header.py index df139f0..2441704 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -44,7 +44,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): """ def __init__(self): - nyx.panel.DaemonPanel.__init__(self, 'header', update_rate = UPDATE_RATE) + nyx.panel.DaemonPanel.__init__(self, 'header', UPDATE_RATE) self._vals = Sampling.create() self._last_width = nyx.curses.screen_size()[0] diff --git a/nyx/panel/log.py b/nyx/panel/log.py index 1e1e87e..3e8932d 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -66,7 +66,7 @@ class LogPanel(nyx.panel.DaemonPanel): """ def __init__(self): - nyx.panel.DaemonPanel.__init__(self, 'log', update_rate = UPDATE_RATE) + nyx.panel.DaemonPanel.__init__(self, 'log', UPDATE_RATE) logged_events = nyx.arguments.expand_events(CONFIG['startup.events']) self._event_log = nyx.log.LogGroup(CONFIG['cache.log_panel.size'], group_by_day = True) diff --git a/nyx/panel/torrc.py b/nyx/panel/torrc.py index 2943807..b279ea0 100644 --- a/nyx/panel/torrc.py +++ b/nyx/panel/torrc.py @@ -24,7 +24,7 @@ class TorrcPanel(panel.Panel): """ def __init__(self): - panel.Panel.__init__(self, 'torrc', 0) + panel.Panel.__init__(self, 'torrc') self._scroller = nyx.curses.Scroller() self._show_line_numbers = True # shows left aligned line numbers

1 0

[nyx/master] Restore ability to reconnect to tor
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 520200cd8d8d29181795b17ed6b22acd59af2138 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 11 09:42:40 2016 -0700 Restore ability to reconnect to tor While rewriting I disabled our ability to reconnect when tor has been restarted. Turns out reason it wasn't working was because we needed a thread safe 'connect and reauthenticate' method. Lack of thread safety was causing our other controller activity to disrupt re-authentication. All seems to be well now. --- nyx/panel/header.py | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 01922ec..998a20d 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -31,6 +31,7 @@ UPDATE_RATE = 5 # rate in seconds at which we refresh CONFIG = conf.config_dict('nyx', { 'attr.flag_colors': {}, 'attr.version_status_colors': {}, + 'tor.chroot': '', }) @@ -137,22 +138,11 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): if self._vals.is_connected: return - # TODO: This is borked. Not quite sure why but our attempt to call - # PROTOCOLINFO fails with a socket error, followed by completely freezing - # nyx. This is exposing two bugs... - # - # * This should be working. That's a stem issue. - # * Our interface shouldn't be locking up. That's an nyx issue. - - return - controller = tor_controller() try: - controller.connect() - try: - controller.authenticate() # TODO: should account for our chroot + controller.reconnect(chroot_path = CONFIG['tor.chroot']) except stem.connection.MissingPassword: password = self.input_prompt('Controller Password: ')

1 0

[nyx/master] Move panel threading to subclass
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit e0adea1ffcccf1cde046dfad698da7ce6f19b51d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 18:02:56 2016 -0700 Move panel threading to subclass Three of our panels are also threads, performing actions at a set rate. All three have identical boilerplate so moving this to a DaemonPanel sublass of Panel. This rejiggers how the log panel works. The work it did to sleep minimal amounts of time was both silly and pointless. --- nyx/panel/__init__.py | 46 ++++++++++++++++++++++++++++++++++++++++-- nyx/panel/connection.py | 47 ++----------------------------------------- nyx/panel/header.py | 37 ++-------------------------------- nyx/panel/log.py | 53 +++++++++---------------------------------------- nyxrc.sample | 4 ---- 5 files changed, 57 insertions(+), 130 deletions(-) diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index 028ba73..86e64ac 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -6,11 +6,12 @@ Panels consisting the nyx interface. """ import collections -import inspect -import time import curses import curses.ascii import curses.textpad +import inspect +import threading +import time import nyx.curses import stem.util.log @@ -710,3 +711,44 @@ class Panel(object): self.addch(top, left + width - 1, curses.ACS_URCORNER, *attributes) self.addch(top + height - 1, left, curses.ACS_LLCORNER, *attributes) self.addch(top + height - 1, left + width - 1, curses.ACS_LRCORNER, *attributes) + + +class DaemonPanel(Panel, threading.Thread): + def __init__(self, name, top = 0, left = 0, height = -1, width = -1, update_rate = 10): + Panel.__init__(self, name, top, left, height, width) + threading.Thread.__init__(self) + self.setDaemon(True) + + self._pause_condition = threading.Condition() + self._halt = False # terminates thread if true + self._update_rate = update_rate + + def _update(self): + pass + + def run(self): + """ + Performs our _update() action at the given rate. + """ + + last_ran = -1 + + while not self._halt: + if self.is_paused() or (time.time() - last_ran) < self._update_rate: + with self._pause_condition: + if not self._halt: + self._pause_condition.wait(0.2) + + continue # done waiting, try again + + self._update() + last_ran = time.time() + + def stop(self): + """ + Halts further resolutions and terminates the thread. + """ + + with self._pause_condition: + self._halt = True + self._pause_condition.notifyAll() diff --git a/nyx/panel/connection.py b/nyx/panel/connection.py index e7e80f5..b75376d 100644 --- a/nyx/panel/connection.py +++ b/nyx/panel/connection.py @@ -10,7 +10,6 @@ import time import collections import curses import itertools -import threading import nyx.curses import nyx.panel @@ -256,16 +255,14 @@ class CircuitEntry(Entry): return False -class ConnectionPanel(nyx.panel.Panel, threading.Thread): +class ConnectionPanel(nyx.panel.DaemonPanel): """ Listing of connections tor is making, with information correlated against the current consensus and other data sources. """ def __init__(self): - nyx.panel.Panel.__init__(self, 'connections') - threading.Thread.__init__(self) - self.setDaemon(True) + nyx.panel.DaemonPanel.__init__(self, 'connections', update_rate = UPDATE_RATE) self._scroller = nyx.curses.CursorScroller() self._entries = [] # last fetched display entries @@ -274,9 +271,6 @@ class ConnectionPanel(nyx.panel.Panel, threading.Thread): self._last_resource_fetch = -1 # timestamp of the last ConnectionResolver results used - self._pause_condition = threading.Condition() - self._halt = False # terminates thread if true - # Tracks exiting port and client country statistics self._client_locale_usage = {} @@ -317,34 +311,6 @@ class ConnectionPanel(nyx.panel.Panel, threading.Thread): self._sort_order = results self._entries = sorted(self._entries, key = lambda entry: [entry.sort_value(attr) for attr in self._sort_order]) - def run(self): - """ - Keeps connections listing updated, checking for new entries at a set rate. - """ - - last_ran = -1 - - while not self._halt: - if self.is_paused() or not tor_controller().is_alive() or (time.time() - last_ran) < UPDATE_RATE: - with self._pause_condition: - if not self._halt: - self._pause_condition.wait(0.2) - - continue # done waiting, try again - - self._update() - self.redraw(True) - - # TODO: The following is needed to show results *but* causes curses to - # flicker. For our plans on this see... - # - # https://trac.torproject.org/projects/tor/ticket/18547#comment:1 - - # if last_ran == -1: - # nyx.tracker.get_consensus_tracker().update(tor_controller().get_network_statuses([])) - - last_ran = time.time() - def key_handlers(self): def _scroll(key): page_height = self.get_preferred_size()[0] - 1 @@ -630,15 +596,6 @@ class ConnectionPanel(nyx.panel.Panel, threading.Thread): x = self.addstr(y, x, line.entry.get_type().upper(), BOLD, *attr) x = self.addstr(y, x, ')', *attr) - def stop(self): - """ - Halts further resolutions and terminates the thread. - """ - - with self._pause_condition: - self._halt = True - self._pause_condition.notifyAll() - def _update(self): """ Fetches the newest resolved connections. diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 164929b..df139f0 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -9,7 +9,6 @@ available. import os import time -import threading import stem import stem.control @@ -39,21 +38,16 @@ CONFIG = conf.config_dict('nyx', { }) -class HeaderPanel(nyx.panel.Panel, threading.Thread): +class HeaderPanel(nyx.panel.DaemonPanel): """ Top area containing tor settings and system information. """ def __init__(self): - nyx.panel.Panel.__init__(self, 'header') - threading.Thread.__init__(self) - self.setDaemon(True) - + nyx.panel.DaemonPanel.__init__(self, 'header', update_rate = UPDATE_RATE) self._vals = Sampling.create() self._last_width = nyx.curses.screen_size()[0] - self._pause_condition = threading.Condition() - self._halt = False # terminates thread if true self._reported_inactive = False self._message = None @@ -200,33 +194,6 @@ class HeaderPanel(nyx.panel.Panel, threading.Thread): _draw_status(subwindow, 0, subwindow.height - 1, self.is_paused(), self._message, *self._message_attr) - def run(self): - """ - Keeps stats updated, checking for new information at a set rate. - """ - - last_ran = -1 - - while not self._halt: - if self.is_paused() or not self._vals.is_connected or (time.time() - last_ran) < UPDATE_RATE: - with self._pause_condition: - if not self._halt: - self._pause_condition.wait(0.2) - - continue # done waiting, try again - - self._update() - last_ran = time.time() - - def stop(self): - """ - Halts further resolutions and terminates the thread. - """ - - with self._pause_condition: - self._halt = True - self._pause_condition.notifyAll() - def reset_listener(self, controller, event_type, _): self._update() diff --git a/nyx/panel/log.py b/nyx/panel/log.py index cc8183b..1e1e87e 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -9,7 +9,6 @@ regular expressions. import os import time -import threading import stem.response.events @@ -28,8 +27,6 @@ from stem.util import conf, log def conf_handler(key, value): if key == 'features.log.prepopulateReadLimit': return max(0, value) - elif key == 'features.log.maxRefreshRate': - return max(10, value) elif key == 'cache.log_panel.size': return max(1000, value) @@ -41,11 +38,12 @@ CONFIG = conf.config_dict('nyx', { 'features.log.showDuplicateEntries': False, 'features.log.prepopulate': True, 'features.log.prepopulateReadLimit': 5000, - 'features.log.maxRefreshRate': 300, 'features.log.regex': [], 'startup.events': 'N3', }, conf_handler) +UPDATE_RATE = 0.3 + # The height of the drawn content is estimated based on the last time we redrew # the panel. It's chiefly used for scrolling and the bar indicating its # position. Letting the estimate be too inaccurate results in a display bug, so @@ -61,16 +59,14 @@ NYX_LOGGER = log.LogBuffer(log.Runlevel.DEBUG, yield_records = True) stem_logger.addHandler(NYX_LOGGER) -class LogPanel(nyx.panel.Panel, threading.Thread): +class LogPanel(nyx.panel.DaemonPanel): """ Listens for and displays tor, nyx, and stem events. This prepopulates from tor's log file if it exists. """ def __init__(self): - nyx.panel.Panel.__init__(self, 'log') - threading.Thread.__init__(self) - self.setDaemon(True) + nyx.panel.DaemonPanel.__init__(self, 'log', update_rate = UPDATE_RATE) logged_events = nyx.arguments.expand_events(CONFIG['startup.events']) self._event_log = nyx.log.LogGroup(CONFIG['cache.log_panel.size'], group_by_day = True) @@ -81,9 +77,8 @@ class LogPanel(nyx.panel.Panel, threading.Thread): self._show_duplicates = CONFIG['features.log.showDuplicateEntries'] self._scroller = nyx.curses.Scroller() - self._halt = False # terminates thread if true - self._pause_condition = threading.Condition() self._has_new_event = False + self._last_day = nyx.log.day_count(time.time()) # fetches past tor events from log file, if available @@ -359,46 +354,19 @@ class LogPanel(nyx.panel.Panel, threading.Thread): return y + 1 - def run(self): + def _update(self): """ Redraws the display, coalescing updates if events are rapidly logged (for instance running at the DEBUG runlevel) while also being immediately responsive if additions are less frequent. """ - last_ran, last_day = -1, nyx.log.day_count(time.time()) - - while not self._halt: - current_day = nyx.log.day_count(time.time()) - time_since_reset = time.time() - last_ran - max_log_update_rate = CONFIG['features.log.maxRefreshRate'] / 1000.0 - - sleep_time = 0 - - if (not self._has_new_event and last_day == current_day) or self.is_paused(): - sleep_time = 5 - elif time_since_reset < max_log_update_rate: - sleep_time = max(0.05, max_log_update_rate - time_since_reset) - - if sleep_time: - with self._pause_condition: - if not self._halt: - self._pause_condition.wait(sleep_time) - - continue + current_day = nyx.log.day_count(time.time()) - last_ran, last_day = time.time(), current_day + if self._has_new_event or self._last_day != current_day: + self._last_day = current_day self.redraw(True) - def stop(self): - """ - Halts further updates and terminates the thread. - """ - - with self._pause_condition: - self._halt = True - self._pause_condition.notifyAll() - def _register_tor_event(self, event): msg = ' '.join(str(event).split(' ')[1:]) @@ -426,6 +394,3 @@ class LogPanel(nyx.panel.Panel, threading.Thread): if self._filter.match(event.display_message): self._has_new_event = True - - with self._pause_condition: - self._pause_condition.notifyAll() diff --git a/nyxrc.sample b/nyxrc.sample index 612af6b..7bb300c 100644 --- a/nyxrc.sample +++ b/nyxrc.sample @@ -63,16 +63,12 @@ features.confirmQuit true # prepopulateReadLimit # maximum entries read from the log file, used to prevent huge log files from # causing a slow startup time. -# maxRefreshRate -# rate limiting (in milliseconds) for drawing the log if updates are made -# rapidly (for instance, when at the DEBUG runlevel) # regex # preconfigured regular expression pattern, up to five will be loaded features.log.showDuplicateEntries false features.log.prepopulate true features.log.prepopulateReadLimit 5000 -features.log.maxRefreshRate 300 #features.log.regex My First Regex Pattern #features.log.regex ^My Second Regex Pattern$

1 0

[nyx/master] Crashed if event popup not provided with any input
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit 80be479323ab50ec1d764a26bc2cecfd9c236c1b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 13:10:32 2016 -0700 Crashed if event popup not provided with any input Didn't account for the None value when this dialog is canceled... File "./run_nyx", line 8, in <module> nyx.main() File "/home/atagar/Desktop/nyx/nyx/__init__.py", line 60, in main nyx.starter.main() File "/home/atagar/Desktop/nyx/stem/util/conf.py", line 289, in wrapped return func(*args, config = config, **kwargs) File "/home/atagar/Desktop/nyx/nyx/starter.py", line 89, in main nyx.curses.start(nyx.controller.start_nyx, transparent_background = True, cursor = False) File "/home/atagar/Desktop/nyx/nyx/curses.py", line 190, in start curses.wrapper(_wrapper) File "/usr/lib/python2.7/curses/wrapper.py", line 43, in wrapper return func(stdscr, *args, **kwds) File "/home/atagar/Desktop/nyx/nyx/curses.py", line 188, in _wrapper function() File "/home/atagar/Desktop/nyx/nyx/controller.py", line 370, in start_nyx keybinding.handle(key) File "/home/atagar/Desktop/nyx/nyx/panel/__init__.py", line 81, in handle self._action() File "/home/atagar/Desktop/nyx/nyx/panel/log.py", line 147, in show_event_selection_prompt self._event_types = nyx.log.listen_for_events(self._register_tor_event, event_types) File "/home/atagar/Desktop/nyx/nyx/log.py", line 178, in listen_for_events events = set(events) # drops duplicates TypeError: 'NoneType' object is not iterable --- nyx/panel/log.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nyx/panel/log.py b/nyx/panel/log.py index a18b2ce..cc8183b 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -143,7 +143,7 @@ class LogPanel(nyx.panel.Panel, threading.Thread): event_types = nyx.popups.select_event_types() - if event_types != self._event_types: + if event_types and event_types != self._event_types: self._event_types = nyx.log.listen_for_events(self._register_tor_event, event_types) self.redraw(True)

1 0

[nyx/master] Curses str_input() function for getting input
by atagar＠torproject.org 18 Apr '16

18 Apr '16

commit da970b76736b836360da85de1b609d584990d002 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 17 19:50:31 2016 -0700 Curses str_input() function for getting input Replacing our Panel's getstr() method with simplified version in our curses module. This drops workarounds to work with python 2.5 (meh) and formatted initial text (unused). --- nyx/curses.py | 66 ++++++++++++++++++++++++ nyx/panel/__init__.py | 139 -------------------------------------------------- nyx/panel/header.py | 4 +- 3 files changed, 68 insertions(+), 141 deletions(-) diff --git a/nyx/curses.py b/nyx/curses.py index ebe5eef..f357443 100644 --- a/nyx/curses.py +++ b/nyx/curses.py @@ -14,6 +14,7 @@ if we want Windows support in the future too. start - initializes curses with the given function raw_screen - provides direct access to the curses screen key_input - get keypress by user + str_input - text field where user can input a string curses_attr - curses encoded text attribute screen_size - provides the dimensions of our screen screenshot - dump of the present on-screen content @@ -82,6 +83,8 @@ from __future__ import absolute_import import collections import curses +import curses.ascii +import curses.textpad import threading import stem.util.conf @@ -239,6 +242,69 @@ def key_input(input_timeout = None): return KeyInput(CURSES_SCREEN.getch()) +def str_input(x, y, initial_text = ''): + """ + 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 + this terminates and provides back **None**. + + This blanks any content within the space that the input field is rendered + (otherwise stray characters would be interpreted as part of the initial + input). + + :param int x: horizontal location + :param int y: vertical location + :param str initial_text: initial input of the field + + :returns: **str** with the user input or **None** if the prompt is caneled + """ + + def handle_key(textbox, key): + y, x = textbox.win.getyx() + + if key == 27: + return curses.ascii.BEL # user pressed esc + elif key == curses.KEY_HOME: + textbox.win.move(y, 0) + 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: + textbox.win.move(y, msg_length - 1) # if we're in the content then move to the end + elif key == curses.KEY_RIGHT and x < msg_length - 1: + textbox.win.move(y, x + 1) # only move cursor if there's content after it + 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 + else: + return key + + with CURSES_LOCK: + try: + curses.curs_set(1) # show cursor + except curses.error: + pass + + width = screen_size().width - x + + curses_subwindow = CURSES_SCREEN.subwin(1, width, y, x) + curses_subwindow.erase() + curses_subwindow.addstr(0, 0, initial_text[:width - 1]) + + textbox = curses.textpad.Textbox(curses_subwindow, insert_mode = True) + user_input = textbox.edit(lambda key: handle_key(textbox, key)).strip() + + try: + curses.curs_set(0) # hide cursor + except curses.error: + pass + + return None if textbox.lastcmd == curses.ascii.BEL else user_input + + def curses_attr(*attributes): """ Provides encoding for the given curses text attributes. diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index 39b8f85..1f5143d 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -7,8 +7,6 @@ Panels consisting the nyx interface. import collections import curses -import curses.ascii -import curses.textpad import inspect import threading import time @@ -19,8 +17,6 @@ import stem.util.log from nyx.curses import HIGHLIGHT from stem.util import conf, str_tools -PASS = -1 - __all__ = [ 'config', 'connection', @@ -82,76 +78,6 @@ class KeyHandler(collections.namedtuple('Help', ['key', 'description', 'current' self._action() -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 @@ -504,71 +430,6 @@ class Panel(object): return x, y - def getstr(self, y, x, initial_text = ''): - """ - 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 - this terminates and provides back None. This should only be called from - the context of a panel's draw method. - - This blanks any content within the space that the input field is rendered - (otherwise stray characters would be interpreted as part of the initial - input). - - Arguments: - y - vertical location - x - horizontal location - initial_text - starting text in this field - """ - - # makes cursor visible - - try: - previous_cursor_state = curses.curs_set(1) - except curses.error: - previous_cursor_state = 0 - - # temporary subwindow for user input - - display_width = self.get_preferred_size()[1] - - with nyx.curses.raw_screen() as stdscr: - input_subwindow = stdscr.subwin(1, display_width - x, self.top + y, self.left + x) - - # blanks the field's area, filling it with the font in case it's hilighting - - input_subwindow.clear() - input_subwindow.bkgd(' ', curses.A_NORMAL) - - # prepopulates the initial text - - if initial_text: - input_subwindow.addstr(0, 0, initial_text[:display_width - x - 1], curses.A_NORMAL) - - # Displays the text field, blocking until the user's done. This closes the - # text panel and returns user_input to the initial text if the user presses - # escape. - - textbox = curses.textpad.Textbox(input_subwindow) - - validator = BasicValidator() - - textbox.win.attron(curses.A_NORMAL) - user_input = textbox.edit(lambda key: validator.validate(key, textbox)).strip() - textbox.win.attroff(curses.A_NORMAL) - - if textbox.lastcmd == curses.ascii.BEL: - user_input = None - - # reverts visability settings - - try: - curses.curs_set(previous_cursor_state) - except curses.error: - pass - - return user_input - def add_scroll_bar(self, top, bottom, size, draw_top = 0): """ Draws a left justified scroll bar reflecting position within a vertical diff --git a/nyx/panel/header.py b/nyx/panel/header.py index 2441704..6551800 100644 --- a/nyx/panel/header.py +++ b/nyx/panel/header.py @@ -47,7 +47,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): nyx.panel.DaemonPanel.__init__(self, 'header', UPDATE_RATE) self._vals = Sampling.create() - self._last_width = nyx.curses.screen_size()[0] + self._last_width = nyx.curses.screen_size().width self._reported_inactive = False self._message = None @@ -90,7 +90,7 @@ class HeaderPanel(nyx.panel.DaemonPanel): self.show_message(message) self.redraw(True) - user_input = self.getstr(self.get_height() - 1, len(message), initial_value) + user_input = nyx.curses.str_input(len(message), self.get_height() - 1, initial_value) self.show_message() return user_input

1 0