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

[nyx/master] Make torrc panel attributes private
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 23d9fba2134017d53f900051534663a5c7e8404f Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 6 21:12:17 2016 -0800 Make torrc panel attributes private Flagging our attributes as private and moving some strings to the config. --- nyx/settings/strings.cfg | 7 +++- nyx/torrc_panel.py | 99 ++++++++++++++++++++++++++---------------------- 2 files changed, 58 insertions(+), 48 deletions(-) diff --git a/nyx/settings/strings.cfg b/nyx/settings/strings.cfg index 85b4f8d..6cfca83 100644 --- a/nyx/settings/strings.cfg +++ b/nyx/settings/strings.cfg @@ -20,11 +20,14 @@ msg.config.nothing_loaded No nyxrc loaded, using defaults. You can customize nyx msg.debug.saving_to_path Saving a debug log to {path}, please check it for sensitive information before sharing it. msg.debug.unable_to_write_file Unable to write to our debug log file ({path}): {error} -msg.panel.graphing.prepopulation_successful Bandwidth graph has information for the last {duration} -msg.panel.graphing.bw_event_cache_malformed Tor's 'GETINFO bw-event-cache' provided malformed output: {response} msg.panel.header.fd_used_at_sixty_percent Tor's file descriptor usage is at {percentage}%. msg.panel.header.fd_used_at_ninety_percent Tor's file descriptor usage is at {percentage}%. If you run out Tor will be unable to continue functioning. +msg.panel.graphing.prepopulation_successful Bandwidth graph has information for the last {duration} +msg.panel.graphing.bw_event_cache_malformed Tor's 'GETINFO bw-event-cache' provided malformed output: {response} msg.panel.log.read_from_log_file Read {count} entries from tor's log file: {path} (read limit: {read_limit}, runtime: {runtime}) +msg.panel.torrc.no_torrc ### Unable to load the torrc ### +msg.panel.torrc.unable_to_find_torrc Unable to determine our torrc location ({error}) +msg.panel.torrc.unable_to_load_torrc Unable to load torrc ({error}) msg.setup.nyx_is_running_as_root Nyx is currently running with root permissions. This isn't a good idea, nor should it be necessary. msg.setup.chroot_doesnt_exist The chroot path set in your config ({path}) doesn't exist. diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 0b456d8..a1ad943 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -5,8 +5,9 @@ Panel displaying the torrc or nyxrc with the validation done against it. import math import curses -from nyx.util import expand_path, panel, tor_controller, ui_tools +from nyx.util import expand_path, msg, panel, tor_controller, ui_tools +from stem import ControllerError from stem.control import State from stem.util import log, str_tools @@ -22,9 +23,9 @@ class TorrcPanel(panel.Panel): def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, 'torrc', 0) - self.scroll = 0 - self.show_line_num = True # shows left aligned line numbers - self.strip_comments = False # drops comments and extra whitespace + self._scroll = 0 + self._show_line_numbers = True # shows left aligned line numbers + self._strip_comments = False # drops comments and extra whitespace # height of the content when last rendered (the cached value is invalid if # _last_content_height_args is None or differs from the current dimensions) @@ -32,8 +33,8 @@ class TorrcPanel(panel.Panel): self._last_content_height = 1 self._last_content_height_args = None - self.torrc_location = '' - self.torrc_content = None + self._torrc_location = '' + self._torrc_content = None # listens for tor reload (sighup) events @@ -49,14 +50,19 @@ class TorrcPanel(panel.Panel): """ if event_type == State.RESET: - self.torrc_location = expand_path(controller.get_info('config-file', None)) - try: - with open(self.torrc_location) as torrc_file: - self.torrc_content = torrc_file.readlines() + self._torrc_location = expand_path(controller.get_info('config-file')) + + with open(self._torrc_location) as torrc_file: + self._torrc_content = torrc_file.readlines() + except ControllerError as exc: + log_msg = msg('panel.torrc.unable_to_find_torrc', error = exc.strerror) + log.log_once('torrc_load_failed', log.WARN, log_msg) + self._torrc_content = None except IOError as exc: - log.log_once('torrc_load_failed', log.WARN, 'Unable to load torrc (%s)' % exc.strerror) - self.torrc_content = None + log_msg = msg('panel.torrc.unable_to_load_torrc', error = exc.strerror) + log.log_once('torrc_load_failed', log.WARN, log_msg) + self._torrc_content = None def set_comments_visible(self, is_visible): """ @@ -66,7 +72,7 @@ class TorrcPanel(panel.Panel): is_visible - displayed comments and blank lines if true, strips otherwise """ - self.strip_comments = not is_visible + self._strip_comments = not is_visible self._last_content_height_args = None self.redraw(True) @@ -78,22 +84,22 @@ class TorrcPanel(panel.Panel): is_visible - displays line numbers if true, hides otherwise """ - self.show_line_num = is_visible + self._show_line_numbers = is_visible self._last_content_height_args = None self.redraw(True) def handle_key(self, key): if key.is_scroll(): page_height = self.get_preferred_size()[0] - 1 - new_scroll = ui_tools.get_scroll_position(key, self.scroll, page_height, self._last_content_height) + new_scroll = ui_tools.get_scroll_position(key, self._scroll, page_height, self._last_content_height) - if self.scroll != new_scroll: - self.scroll = new_scroll + if self._scroll != new_scroll: + self._scroll = new_scroll self.redraw(True) elif key.match('n'): - self.set_line_number_visible(not self.show_line_num) + self.set_line_number_visible(not self._show_line_numbers) elif key.match('s'): - self.set_comments_visible(self.strip_comments) + self.set_comments_visible(self._strip_comments) else: return False @@ -111,8 +117,8 @@ class TorrcPanel(panel.Panel): ('down arrow', 'scroll down a line', None), ('page up', 'scroll up a page', None), ('page down', 'scroll down a page', None), - ('s', 'comment stripping', 'on' if self.strip_comments else 'off'), - ('n', 'line numbering', 'on' if self.show_line_num else 'off'), + ('s', 'comment stripping', 'on' if self._strip_comments else 'off'), + ('n', 'line numbering', 'on' if self._show_line_numbers else 'off'), ('x', 'reset tor (issue sighup)', None), ] @@ -127,25 +133,26 @@ class TorrcPanel(panel.Panel): # restricts scroll location to valid bounds - self.scroll = max(0, min(self.scroll, self._last_content_height - height + 1)) + self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - if self.torrc_content is None: - rendered_contents = ['### Unable to load the torrc ###'] + if self._torrc_content is None: + rendered_contents = [msg('panel.torrc.no_torrc')] else: - rendered_contents = [ui_tools.get_printable(line.replace('\t', ' ')) for line in self.torrc_content] + rendered_contents = [] + + for line in self._torrc_content: + line = ui_tools.get_printable(line.replace('\t', ' ')) - if self.strip_comments: - for i in range(len(rendered_contents)): - line = rendered_contents[i] + if self._strip_comments and '#' in line: + line = line[:line.find('#')].strip() - if line and '#' in line: - rendered_contents[i] = line[:line.find('#')].strip() + rendered_contents.append(line) # offset to make room for the line numbers line_number_offset = 0 - if self.show_line_num: + if self._show_line_numbers: if len(rendered_contents) == 0: line_number_offset = 2 else: @@ -157,14 +164,14 @@ class TorrcPanel(panel.Panel): if self._last_content_height > height - 1: scroll_offset = 3 - self.add_scroll_bar(self.scroll, self.scroll + height - 1, self._last_content_height, 1) + self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) - display_line = -self.scroll + 1 # line we're drawing on + display_line = -self._scroll + 1 # line we're drawing on # draws the top label if self.is_title_visible(): - location_label = ' (%s)' % self.torrc_location + location_label = ' (%s)' % self._torrc_location self.addstr(0, 0, 'Tor Configuration File%s:' % (location_label), curses.A_STANDOUT) is_multiline = False # true if we're in the middle of a multiline torrc entry @@ -175,10 +182,10 @@ class TorrcPanel(panel.Panel): # blank lines are hidden when stripping comments - if self.strip_comments and not line_text: + if self._strip_comments and not line_text: continue - # splits the line into its component (msg, format) tuples + # splits the line into its component (label, attr) tuples line_comp = { 'option': ['', (curses.A_BOLD, 'green')], @@ -221,7 +228,7 @@ class TorrcPanel(panel.Panel): # draws the line number - if self.show_line_num and display_line < height and display_line >= 1: + if self._show_line_numbers and display_line < height and display_line >= 1: line_number_str = ('%%%ii' % (line_number_offset - 1)) % (line_number + 1) self.addstr(display_line, scroll_offset, line_number_str, curses.A_BOLD, 'yellow') @@ -231,29 +238,29 @@ class TorrcPanel(panel.Panel): display_queue = [line_comp[entry] for entry in ('option', 'argument', 'correction', 'comment')] while display_queue: - msg, format = display_queue.pop(0) + label, attr = display_queue.pop(0) max_msg_size, include_break = width - cursor_location, False - if len(msg) >= max_msg_size: + if len(label) >= max_msg_size: # message is too long - break it up if line_offset == MAX_WRAP_PER_LINE - 1: - msg = str_tools.crop(msg, max_msg_size) + label = str_tools.crop(label, max_msg_size) else: include_break = True - msg, remainder = str_tools.crop(msg, max_msg_size, 4, 4, str_tools.Ending.HYPHEN, True) - display_queue.insert(0, (remainder.strip(), format)) + label, remainder = str_tools.crop(label, max_msg_size, 4, 4, str_tools.Ending.HYPHEN, True) + display_queue.insert(0, (remainder.strip(), attr)) draw_line = display_line + line_offset - if msg and draw_line < height and draw_line >= 1: - self.addstr(draw_line, cursor_location, msg, *format) + if label and draw_line < height and draw_line >= 1: + self.addstr(draw_line, cursor_location, label, *attr) # If we're done, and have added content to this line, then start # further content on the next line. - cursor_location += len(msg) + cursor_location += len(label) include_break |= not display_queue and cursor_location != line_number_offset + scroll_offset if include_break: @@ -267,7 +274,7 @@ class TorrcPanel(panel.Panel): if not trust_last_content_height: self._last_content_height_args = (width, height) - new_content_height = display_line + self.scroll - 1 + new_content_height = display_line + self._scroll - 1 if self._last_content_height != new_content_height: self._last_content_height = new_content_height

1 0

[nyx/master] Show torrc load errors
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit b8b44d7b45cd44411616bda8d05fdffa8c620624 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 7 21:35:24 2016 -0800 Show torrc load errors Showing rather than logging torrc load errors. This is where users want that information anyway. --- nyx/settings/strings.cfg | 5 ++--- nyx/torrc_panel.py | 45 ++++++++++++++++++++++----------------------- 2 files changed, 24 insertions(+), 26 deletions(-) diff --git a/nyx/settings/strings.cfg b/nyx/settings/strings.cfg index 6cfca83..bfe375f 100644 --- a/nyx/settings/strings.cfg +++ b/nyx/settings/strings.cfg @@ -25,9 +25,8 @@ msg.panel.header.fd_used_at_ninety_percent Tor's file descriptor usage is at {pe msg.panel.graphing.prepopulation_successful Bandwidth graph has information for the last {duration} msg.panel.graphing.bw_event_cache_malformed Tor's 'GETINFO bw-event-cache' provided malformed output: {response} msg.panel.log.read_from_log_file Read {count} entries from tor's log file: {path} (read limit: {read_limit}, runtime: {runtime}) -msg.panel.torrc.no_torrc ### Unable to load the torrc ### -msg.panel.torrc.unable_to_find_torrc Unable to determine our torrc location ({error}) -msg.panel.torrc.unable_to_load_torrc Unable to load torrc ({error}) +msg.panel.torrc.unable_to_find_torrc Unable to determine our torrc location: {error} +msg.panel.torrc.unable_to_load_torrc Unable to read our torrc: {error} msg.setup.nyx_is_running_as_root Nyx is currently running with root permissions. This isn't a good idea, nor should it be necessary. msg.setup.chroot_doesnt_exist The chroot path set in your config ({path}) doesn't exist. diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index a1ad943..34b6c3a 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -9,7 +9,7 @@ from nyx.util import expand_path, msg, panel, tor_controller, ui_tools from stem import ControllerError from stem.control import State -from stem.util import log, str_tools +from stem.util import str_tools MAX_WRAP_PER_LINE = 8 @@ -24,8 +24,8 @@ class TorrcPanel(panel.Panel): panel.Panel.__init__(self, stdscr, 'torrc', 0) self._scroll = 0 - self._show_line_numbers = True # shows left aligned line numbers - self._strip_comments = False # drops comments and extra whitespace + self._show_line_numbers = True # shows left aligned line numbers + self._strip_comments = False # drops comments and extra whitespace # height of the content when last rendered (the cached value is invalid if # _last_content_height_args is None or differs from the current dimensions) @@ -33,8 +33,9 @@ class TorrcPanel(panel.Panel): self._last_content_height = 1 self._last_content_height_args = None - self._torrc_location = '' + self._torrc_location = None self._torrc_content = None + self._torrc_load_error = None # listens for tor reload (sighup) events @@ -56,12 +57,11 @@ class TorrcPanel(panel.Panel): with open(self._torrc_location) as torrc_file: self._torrc_content = torrc_file.readlines() except ControllerError as exc: - log_msg = msg('panel.torrc.unable_to_find_torrc', error = exc.strerror) - log.log_once('torrc_load_failed', log.WARN, log_msg) + self._torrc_load_error = msg('panel.torrc.unable_to_find_torrc', error = exc) + self._torrc_location = None self._torrc_content = None - except IOError as exc: - log_msg = msg('panel.torrc.unable_to_load_torrc', error = exc.strerror) - log.log_once('torrc_load_failed', log.WARN, log_msg) + except Exception as exc: + self._torrc_load_error = msg('panel.torrc.unable_to_load_torrc', error = exc.strerror) self._torrc_content = None def set_comments_visible(self, is_visible): @@ -123,6 +123,14 @@ class TorrcPanel(panel.Panel): ] def draw(self, width, height): + if self.is_title_visible(): + location = ' (%s)' % self._torrc_location if self._torrc_location else '' + self.addstr(0, 0, 'Tor Configuration File%s:' % location, curses.A_STANDOUT) + + if self._torrc_content is None: + self.addstr(1, 0, self._torrc_load_error, 'red', curses.A_BOLD) + return + # If true, we assume that the cached value in self._last_content_height is # still accurate, and stop drawing when there's nothing more to display. # Otherwise the self._last_content_height is suspect, and we'll process all @@ -135,16 +143,13 @@ class TorrcPanel(panel.Panel): self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - if self._torrc_content is None: - rendered_contents = [msg('panel.torrc.no_torrc')] - else: - rendered_contents = [] + rendered_contents = [] - for line in self._torrc_content: - line = ui_tools.get_printable(line.replace('\t', ' ')) + for line in self._torrc_content: + line = ui_tools.get_printable(line.replace('\t', ' ')) - if self._strip_comments and '#' in line: - line = line[:line.find('#')].strip() + if self._strip_comments and '#' in line: + line = line[:line.find('#')].strip() rendered_contents.append(line) @@ -168,12 +173,6 @@ class TorrcPanel(panel.Panel): display_line = -self._scroll + 1 # line we're drawing on - # draws the top label - - if self.is_title_visible(): - location_label = ' (%s)' % self._torrc_location - self.addstr(0, 0, 'Tor Configuration File%s:' % (location_label), curses.A_STANDOUT) - is_multiline = False # true if we're in the middle of a multiline torrc entry for line_number in range(0, len(rendered_contents)):

1 0

[nyx/master] Simpify torrc content height handling
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 439ac3d359f03588c486d3aad3be967a4f99fc8e Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 7 21:56:58 2016 -0800 Simpify torrc content height handling Determining our content's height is actually really tricky for panels with line wrapping such as this and the log. This panel had an attempt at optimization that really wasn't necessary so simplifying this. --- nyx/log_panel.py | 2 +- nyx/torrc_panel.py | 32 +++++--------------------------- 2 files changed, 6 insertions(+), 28 deletions(-) diff --git a/nyx/log_panel.py b/nyx/log_panel.py index e97d74b..258d7a7 100644 --- a/nyx/log_panel.py +++ b/nyx/log_panel.py @@ -278,7 +278,7 @@ class LogPanel(panel.Panel, threading.Thread): event_filter = self._filter.clone() event_types = list(self._event_types) scroll = int(self._scroll) - last_content_height = int(self._last_content_height) + last_content_height = self._last_content_height show_duplicates = self._show_duplicates is_scrollbar_visible = last_content_height > height - 1 diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 34b6c3a..769f09b 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -30,8 +30,7 @@ class TorrcPanel(panel.Panel): # height of the content when last rendered (the cached value is invalid if # _last_content_height_args is None or differs from the current dimensions) - self._last_content_height = 1 - self._last_content_height_args = None + self._last_content_height = 0 self._torrc_location = None self._torrc_content = None @@ -73,7 +72,6 @@ class TorrcPanel(panel.Panel): """ self._strip_comments = not is_visible - self._last_content_height_args = None self.redraw(True) def set_line_number_visible(self, is_visible): @@ -85,7 +83,6 @@ class TorrcPanel(panel.Panel): """ self._show_line_numbers = is_visible - self._last_content_height_args = None self.redraw(True) def handle_key(self, key): @@ -105,12 +102,6 @@ class TorrcPanel(panel.Panel): return True - def set_visible(self, is_visible): - if not is_visible: - self._last_content_height_args = None # redraws when next displayed - - panel.Panel.set_visible(self, is_visible) - def get_help(self): return [ ('up arrow', 'scroll up a line', None), @@ -131,14 +122,6 @@ class TorrcPanel(panel.Panel): self.addstr(1, 0, self._torrc_load_error, 'red', curses.A_BOLD) return - # If true, we assume that the cached value in self._last_content_height is - # still accurate, and stop drawing when there's nothing more to display. - # Otherwise the self._last_content_height is suspect, and we'll process all - # the content to check if it's right (and redraw again with the corrected - # height if not). - - trust_last_content_height = self._last_content_height_args == (width, height) - # restricts scroll location to valid bounds self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) @@ -268,13 +251,8 @@ class TorrcPanel(panel.Panel): display_line += max(line_offset, 1) - if trust_last_content_height and display_line >= height: - break - - if not trust_last_content_height: - self._last_content_height_args = (width, height) - new_content_height = display_line + self._scroll - 1 + new_content_height = display_line + self._scroll - 1 - if self._last_content_height != new_content_height: - self._last_content_height = new_content_height - self.redraw(True) + if self._last_content_height != new_content_height: + self._last_content_height = new_content_height + self.redraw(True)

1 0

[nyx/master] Drop intermediate rendered_contents attribute
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 8dd9a23d0357336a45c2efab736b43213b13b3d4 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Feb 8 12:13:19 2016 -0800 Drop intermediate rendered_contents attribute Intermediate attribute we don't really need. Shifting it to when we read the torrc contents or process its contents. --- nyx/torrc_panel.py | 50 +++++++++++++++++++------------------------------- 1 file changed, 19 insertions(+), 31 deletions(-) diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 769f09b..ffe7b9b 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -54,7 +54,7 @@ class TorrcPanel(panel.Panel): self._torrc_location = expand_path(controller.get_info('config-file')) with open(self._torrc_location) as torrc_file: - self._torrc_content = torrc_file.readlines() + self._torrc_content = [ui_tools.get_printable(line.replace('\t', ' ')) for line in torrc_file.readlines()] except ControllerError as exc: self._torrc_load_error = msg('panel.torrc.unable_to_find_torrc', error = exc) self._torrc_location = None @@ -126,25 +126,15 @@ class TorrcPanel(panel.Panel): self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - rendered_contents = [] - - for line in self._torrc_content: - line = ui_tools.get_printable(line.replace('\t', ' ')) - - if self._strip_comments and '#' in line: - line = line[:line.find('#')].strip() - - rendered_contents.append(line) - # offset to make room for the line numbers line_number_offset = 0 if self._show_line_numbers: - if len(rendered_contents) == 0: + if len(self._torrc_content) == 0: line_number_offset = 2 else: - line_number_offset = int(math.log10(len(rendered_contents))) + 2 + line_number_offset = int(math.log10(len(self._torrc_content))) + 2 # draws left-hand scroll bar if content's longer than the height @@ -155,17 +145,16 @@ class TorrcPanel(panel.Panel): self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) display_line = -self._scroll + 1 # line we're drawing on - is_multiline = False # true if we're in the middle of a multiline torrc entry - for line_number in range(0, len(rendered_contents)): - line_text = rendered_contents[line_number] - line_text = line_text.rstrip() # remove ending whitespace + for line_number in range(0, len(self._torrc_content)): + line = self._torrc_content[line_number] - # blank lines are hidden when stripping comments + if self._strip_comments: + line = line[:line.find('#')].rstrip() if '#' in line else line.rstrip() - if self._strip_comments and not line_text: - continue + if not line: + continue # skip blank lines # splits the line into its component (label, attr) tuples @@ -178,29 +167,29 @@ class TorrcPanel(panel.Panel): # parses the comment - comment_index = line_text.find('#') + comment_index = line.find('#') if comment_index != -1: - line_comp['comment'][0] = line_text[comment_index:] - line_text = line_text[:comment_index] + line_comp['comment'][0] = line[comment_index:] + line = line[:comment_index] # splits the option and argument, preserving any whitespace around them - stripped_line = line_text.strip() + stripped_line = line.strip() option_index = stripped_line.find(' ') if is_multiline: # part of a multiline entry started on a previous line so everything # is part of the argument - line_comp['argument'][0] = line_text + line_comp['argument'][0] = line elif option_index == -1: # no argument provided - line_comp['option'][0] = line_text + line_comp['option'][0] = line else: option_text = stripped_line[:option_index] - option_end = line_text.find(option_text) + len(option_text) - line_comp['option'][0] = line_text[:option_end] - line_comp['argument'][0] = line_text[option_end:] + option_end = line.find(option_text) + len(option_text) + line_comp['option'][0] = line[:option_end] + line_comp['argument'][0] = line[option_end:] # flags following lines as belonging to this multiline entry if it ends # with a slash @@ -211,8 +200,7 @@ class TorrcPanel(panel.Panel): # draws the line number if self._show_line_numbers and display_line < height and display_line >= 1: - line_number_str = ('%%%ii' % (line_number_offset - 1)) % (line_number + 1) - self.addstr(display_line, scroll_offset, line_number_str, curses.A_BOLD, 'yellow') + self.addstr(display_line, scroll_offset, str(line_number + 1).rjust(line_number_offset - 1), curses.A_BOLD, 'yellow') # draws the rest of the components with line wrap

1 0

[nyx/master] Common method for line wrapping
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 475874849090f7a47bea0e4b7987a7d40a454a14 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Feb 9 20:29:30 2016 -0800 Common method for line wrapping Our log panel, torrc panel, and descriptor popup all draw lines with wrapping. Rather then reinvent the wheel three spots adding a helper to our panel. Only change (I hope) is that log panels now don't split with a hyphen. --- nyx/log_panel.py | 30 +++++------------------------- nyx/popups.py | 20 ++------------------ nyx/torrc_panel.py | 37 ++++--------------------------------- nyx/util/panel.py | 31 ++++++++++++++++++++++++++++++- nyxrc.sample | 5 +---- 5 files changed, 42 insertions(+), 81 deletions(-) diff --git a/nyx/log_panel.py b/nyx/log_panel.py index e1c79af..4fdb8ad 100644 --- a/nyx/log_panel.py +++ b/nyx/log_panel.py @@ -15,8 +15,8 @@ import nyx.arguments import nyx.popups import nyx.util.log -from stem.util import conf, log, str_tools from nyx.util import join, panel, tor_controller, ui_tools +from stem.util import conf, log def conf_handler(key, value): @@ -368,38 +368,18 @@ class LogPanel(panel.Panel, threading.Thread): Presents a log entry with line wrapping. """ - def draw_line(x, y, width, msg, *attr): - msg, remaining_lines = msg.split('\n', 1) if ('\n' in msg) else (msg, '') - msg, cropped = str_tools.crop(msg, width - x - 1, min_crop = 4, ending = str_tools.Ending.HYPHEN, get_remainder = True) - x = self.addstr(y, x, msg, *attr) - return x, (cropped + '\n' + remaining_lines).strip() - - def draw_msg(min_x, x, y, width, msg, *attr): - orig_y = y - - while msg: - x, msg = draw_line(x, y, width, msg, *attr) - - if (y - orig_y + 1) >= CONFIG['features.log.maxLineWrap']: - break # filled up the maximum number of lines we're allowing for - - if msg: - msg = ' ' + msg # indent the next line - x, y = min_x, y + 1 - - return x, y - - min_x, msg = x, entry.display_message + min_x, msg = x + 2, entry.display_message boldness = curses.A_BOLD if 'ERR' in entry.type else curses.A_NORMAL # emphasize ERR messages color = CONFIG['attr.log_color'].get(entry.type, 'white') - x, y = draw_msg(min_x, x, y, width, msg, boldness, color) + for line in msg.splitlines(): + x, y = self.addstr_wrap(y, x, line, width, min_x, boldness, color) if entry.duplicates and not show_duplicates: duplicate_count = len(entry.duplicates) - 1 plural = 's' if duplicate_count > 1 else '' duplicate_msg = ' [%i duplicate%s hidden]' % (duplicate_count, plural) - x, y = draw_msg(min_x, x, y, width, duplicate_msg, curses.A_BOLD, 'green') + x, y = self.addstr_wrap(y, x, duplicate_msg, width, min_x, curses.A_BOLD, 'green') return y + 1 diff --git a/nyx/popups.py b/nyx/popups.py index 017b672..c25b321 100644 --- a/nyx/popups.py +++ b/nyx/popups.py @@ -11,8 +11,6 @@ import nyx.controller from nyx import __version__, __release_date__ from nyx.util import tor_controller, panel, ui_tools -from stem.util import str_tools - NO_STATS_MSG = "Usage stats aren't available yet, press any key..." HEADERS = ['Consensus:', 'Microdescriptor:', 'Server Descriptor:'] @@ -529,20 +527,6 @@ def _preferred_size(text, max_width, show_line_numbers): def _draw(popup, title, lines, entry_color, scroll, show_line_numbers): - def draw_msg(popup, min_x, x, y, width, msg, *attr): - while msg: - draw_msg, msg = str_tools.crop(msg, width - x, None, ending = None, get_remainder = True) - - if not draw_msg: - draw_msg, msg = str_tools.crop(msg, width - x), '' # first word is longer than the line - - x = popup.addstr(y, x, draw_msg, *attr) - - if msg: - x, y = min_x, y + 1 - - return x, y - popup.win.erase() line_number_width = int(math.log10(len(lines))) + 1 @@ -574,8 +558,8 @@ def _draw(popup, title, lines, entry_color, scroll, show_line_numbers): if show_line_numbers: popup.addstr(y, 2, str(i + 1).rjust(line_number_width), curses.A_BOLD, LINE_NUMBER_COLOR) - x, y = draw_msg(popup, offset, offset, y, width, keyword, color, curses.A_BOLD) - x, y = draw_msg(popup, offset, x + 1, y, width, value, color) + x, y = popup.addstr_wrap(y, width, keyword, width, offset, color, curses.A_BOLD) + x, y = popup.addstr_wrap(y, x + 1, value, width, offset, color) y += 1 diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 89d42f3..1958b4e 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -9,17 +9,6 @@ from nyx.util import expand_path, msg, panel, tor_controller, ui_tools from stem import ControllerError from stem.control import State -from stem.util import conf, str_tools - - -def conf_handler(key, value): - if key == 'features.torrc.maxLineWrap': - return max(1, value) - - -CONFIG = conf.config_dict('nyx', { - 'features.torrc.maxLineWrap': 8, -}, conf_handler) class TorrcPanel(panel.Panel): @@ -145,25 +134,6 @@ class TorrcPanel(panel.Panel): scroll_offset = 3 self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) - def draw_msg(min_x, x, y, width, msg, *attr): - orig_y = y - - while msg: - draw_msg, msg = str_tools.crop(msg, width - x, None, ending = None, get_remainder = True) - - if not draw_msg: - draw_msg, msg = str_tools.crop(msg, width - x), '' # first word is longer than the line - - x = self.addstr(y, x, draw_msg, *attr) - - if (y - orig_y + 1) >= CONFIG['features.torrc.maxLineWrap']: - break # filled up the maximum number of lines we're allowing for - - if msg: - x, y = min_x, y + 1 - - return x, y - y = 1 - self._scroll is_multiline = False # true if we're in the middle of a multiline torrc entry @@ -178,6 +148,7 @@ class TorrcPanel(panel.Panel): if '#' in line: line, comment = line.split('#', 1) + comment = '#' + comment # splits the option and argument, preserving any whitespace around them @@ -208,9 +179,9 @@ class TorrcPanel(panel.Panel): x = line_number_offset + scroll_offset min_x = line_number_offset + scroll_offset - x, y = draw_msg(min_x, x, y, width, option, curses.A_BOLD, 'green') - x, y = draw_msg(min_x, x, y, width, argument, curses.A_BOLD, 'cyan') - x, y = draw_msg(min_x, x, y, width, comment, 'white') + x, y = self.addstr_wrap(y, x, option, width, min_x, curses.A_BOLD, 'green') + x, y = self.addstr_wrap(y, x, argument, width, min_x, curses.A_BOLD, 'cyan') + x, y = self.addstr_wrap(y, x, comment, width, min_x, 'white') y += 1 diff --git a/nyx/util/panel.py b/nyx/util/panel.py index efade79..136fe85 100644 --- a/nyx/util/panel.py +++ b/nyx/util/panel.py @@ -11,7 +11,7 @@ from threading import RLock from nyx.util import text_input, ui_tools -from stem.util import log +from stem.util import conf, log, str_tools # global ui lock governing all panel instances (curses isn't thread save and # concurrency bugs produce especially sinister glitches) @@ -33,6 +33,16 @@ SPECIAL_KEYS = { } +def conf_handler(key, value): + if key == 'features.torrc.maxLineWrap': + return max(1, value) + + +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 @@ -534,6 +544,25 @@ class Panel(object): return x + def addstr_wrap(self, y, x, msg, width, min_x = 0, *attr): + orig_y = y + + while msg: + draw_msg, msg = str_tools.crop(msg, width - x, None, ending = None, get_remainder = True) + + if not draw_msg: + draw_msg, msg = str_tools.crop(msg, width - x), '' # first word is longer than the line + + x = self.addstr(y, x, draw_msg, *attr) + + if (y - orig_y + 1) >= CONFIG['features.maxLineWrap']: + break # maximum number we'll wrap + + if msg: + x, y = min_x, y + 1 + + return x, y + def getstr(self, y, x, initial_text = '', text_format = None, max_width = None, validator = None): """ Provides a text field where the user can input a string, blocking until diff --git a/nyxrc.sample b/nyxrc.sample index dfb9873..160ce68 100644 --- a/nyxrc.sample +++ b/nyxrc.sample @@ -59,8 +59,6 @@ features.confirmQuit true # showDuplicateEntries # shows all log entries if true, otherwise collapses similar entries with an # indicator for how much is being hidden -# maxLinesPerEntry -# max number of lines to display for a single log entry # prepopulate # attempts to read past events from the log file if true # prepopulateReadLimit @@ -73,14 +71,13 @@ features.confirmQuit true # preconfigured regular expression pattern, up to five will be loaded features.log.showDuplicateEntries false -features.log.maxLineWrap 6 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$ -features.torrc.maxLineWrap 8 +features.maxLineWrap 8 # Paremters for the config panel # ---------------------------

1 0

[nyx/master] Revise torrc line wrapping
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 150630e24005261140270eaef2e5e7bbb0b323c7 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Feb 8 20:20:09 2016 -0800 Revise torrc line wrapping Our log panel and descriptor dialog have simpler line wrapping so opting for a style similar to those. Still a lot of work to go but hell of a lot simpler. :P --- nyx/torrc_panel.py | 102 ++++++++++++++++++++--------------------------------- 1 file changed, 39 insertions(+), 63 deletions(-) diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 21d5576..89d42f3 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -13,7 +13,7 @@ from stem.util import conf, str_tools def conf_handler(key, value): - if key == 'features.log.maxLineWrap': + if key == 'features.torrc.maxLineWrap': return max(1, value) @@ -145,7 +145,26 @@ class TorrcPanel(panel.Panel): scroll_offset = 3 self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) - display_line = -self._scroll + 1 # line we're drawing on + def draw_msg(min_x, x, y, width, msg, *attr): + orig_y = y + + while msg: + draw_msg, msg = str_tools.crop(msg, width - x, None, ending = None, get_remainder = True) + + if not draw_msg: + draw_msg, msg = str_tools.crop(msg, width - x), '' # first word is longer than the line + + x = self.addstr(y, x, draw_msg, *attr) + + if (y - orig_y + 1) >= CONFIG['features.torrc.maxLineWrap']: + break # filled up the maximum number of lines we're allowing for + + if msg: + x, y = min_x, y + 1 + + return x, y + + y = 1 - self._scroll is_multiline = False # true if we're in the middle of a multiline torrc entry for line_number, line in enumerate(self._torrc_content): @@ -155,22 +174,10 @@ class TorrcPanel(panel.Panel): if not line: continue # skip blank lines - # splits the line into its component (label, attr) tuples - - line_comp = { - 'option': ['', (curses.A_BOLD, 'green')], - 'argument': ['', (curses.A_BOLD, 'cyan')], - 'correction': ['', (curses.A_BOLD, 'cyan')], - 'comment': ['', ('white',)], - } - - # parses the comment - - comment_index = line.find('#') + option, argument, comment = '', '', '' - if comment_index != -1: - line_comp['comment'][0] = line[comment_index:] - line = line[:comment_index] + if '#' in line: + line, comment = line.split('#', 1) # splits the option and argument, preserving any whitespace around them @@ -178,67 +185,36 @@ class TorrcPanel(panel.Panel): option_index = stripped_line.find(' ') if is_multiline: - # part of a multiline entry started on a previous line so everything - # is part of the argument - line_comp['argument'][0] = line + argument = line # previous line ended with a '\' elif option_index == -1: - # no argument provided - line_comp['option'][0] = line + option = line # no argument provided else: option_text = stripped_line[:option_index] option_end = line.find(option_text) + len(option_text) - line_comp['option'][0] = line[:option_end] - line_comp['argument'][0] = line[option_end:] + + option = line[:option_end] + argument = line[option_end:] # flags following lines as belonging to this multiline entry if it ends # with a slash - if stripped_line: - is_multiline = stripped_line.endswith('\\') + is_multiline = stripped_line.endswith('\\') # draws the line number - if self._show_line_numbers and display_line < height and display_line >= 1: - self.addstr(display_line, scroll_offset, str(line_number + 1).rjust(line_number_offset - 1), curses.A_BOLD, 'yellow') - - # draws the rest of the components with line wrap - - cursor_location, line_offset = line_number_offset + scroll_offset, 0 - display_queue = [line_comp[entry] for entry in ('option', 'argument', 'correction', 'comment')] - - while display_queue: - label, attr = display_queue.pop(0) - - max_msg_size, include_break = width - cursor_location, False - - if len(label) >= max_msg_size: - # message is too long - break it up - - if line_offset == CONFIG['features.log.maxLineWrap'] - 1: - label = str_tools.crop(label, max_msg_size) - else: - include_break = True - label, remainder = str_tools.crop(label, max_msg_size, 4, 4, str_tools.Ending.HYPHEN, True) - display_queue.insert(0, (remainder.strip(), attr)) - - draw_line = display_line + line_offset - - if label and draw_line < height and draw_line >= 1: - self.addstr(draw_line, cursor_location, label, *attr) - - # If we're done, and have added content to this line, then start - # further content on the next line. + if self._show_line_numbers and y < height and y >= 1: + self.addstr(y, scroll_offset, str(line_number + 1).rjust(line_number_offset - 1), curses.A_BOLD, 'yellow') - cursor_location += len(label) - include_break |= not display_queue and cursor_location != line_number_offset + scroll_offset + x = line_number_offset + scroll_offset + min_x = line_number_offset + scroll_offset - if include_break: - line_offset += 1 - cursor_location = line_number_offset + scroll_offset + x, y = draw_msg(min_x, x, y, width, option, curses.A_BOLD, 'green') + x, y = draw_msg(min_x, x, y, width, argument, curses.A_BOLD, 'cyan') + x, y = draw_msg(min_x, x, y, width, comment, 'white') - display_line += max(line_offset, 1) + y += 1 - new_content_height = display_line + self._scroll - 1 + new_content_height = y + self._scroll - 1 if self._last_content_height != new_content_height: self._last_content_height = new_content_height

1 0

[nyx/master] Make max torrc line wrapping configurable
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit dda12b882596593c3e559ee200c12b4604387a55 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Feb 8 17:48:44 2016 -0800 Make max torrc line wrapping configurable Log panel has a config option for this so might as well mirror it here. --- nyx/log_panel.py | 6 +++--- nyx/torrc_panel.py | 37 ++++++++++++++++++------------------- nyxrc.sample | 4 +++- 3 files changed, 24 insertions(+), 23 deletions(-) diff --git a/nyx/log_panel.py b/nyx/log_panel.py index 258d7a7..e1c79af 100644 --- a/nyx/log_panel.py +++ b/nyx/log_panel.py @@ -20,7 +20,7 @@ from nyx.util import join, panel, tor_controller, ui_tools def conf_handler(key, value): - if key == 'features.log.maxLinesPerEntry': + if key == 'features.log.maxLineWrap': return max(1, value) elif key == 'features.log.prepopulateReadLimit': return max(0, value) @@ -33,7 +33,7 @@ def conf_handler(key, value): CONFIG = conf.config_dict('nyx', { 'features.logFile': '', 'features.log.showDuplicateEntries': False, - 'features.log.maxLinesPerEntry': 6, + 'features.log.maxLineWrap': 6, 'features.log.prepopulate': True, 'features.log.prepopulateReadLimit': 5000, 'features.log.maxRefreshRate': 300, @@ -380,7 +380,7 @@ class LogPanel(panel.Panel, threading.Thread): while msg: x, msg = draw_line(x, y, width, msg, *attr) - if (y - orig_y + 1) >= CONFIG['features.log.maxLinesPerEntry']: + if (y - orig_y + 1) >= CONFIG['features.log.maxLineWrap']: break # filled up the maximum number of lines we're allowing for if msg: diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index ffe7b9b..21d5576 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -9,9 +9,17 @@ from nyx.util import expand_path, msg, panel, tor_controller, ui_tools from stem import ControllerError from stem.control import State -from stem.util import str_tools +from stem.util import conf, str_tools -MAX_WRAP_PER_LINE = 8 + +def conf_handler(key, value): + if key == 'features.log.maxLineWrap': + return max(1, value) + + +CONFIG = conf.config_dict('nyx', { + 'features.torrc.maxLineWrap': 8, +}, conf_handler) class TorrcPanel(panel.Panel): @@ -122,21 +130,14 @@ class TorrcPanel(panel.Panel): self.addstr(1, 0, self._torrc_load_error, 'red', curses.A_BOLD) return - # restricts scroll location to valid bounds - self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - # offset to make room for the line numbers - - line_number_offset = 0 - - if self._show_line_numbers: - if len(self._torrc_content) == 0: - line_number_offset = 2 - else: - line_number_offset = int(math.log10(len(self._torrc_content))) + 2 - - # draws left-hand scroll bar if content's longer than the height + if not self._show_line_numbers: + line_number_offset = 0 + elif len(self._torrc_content) == 0: + line_number_offset = 2 + else: + line_number_offset = int(math.log10(len(self._torrc_content))) + 2 scroll_offset = 0 @@ -147,9 +148,7 @@ class TorrcPanel(panel.Panel): display_line = -self._scroll + 1 # line we're drawing on is_multiline = False # true if we're in the middle of a multiline torrc entry - for line_number in range(0, len(self._torrc_content)): - line = self._torrc_content[line_number] - + for line_number, line in enumerate(self._torrc_content): if self._strip_comments: line = line[:line.find('#')].rstrip() if '#' in line else line.rstrip() @@ -215,7 +214,7 @@ class TorrcPanel(panel.Panel): if len(label) >= max_msg_size: # message is too long - break it up - if line_offset == MAX_WRAP_PER_LINE - 1: + if line_offset == CONFIG['features.log.maxLineWrap'] - 1: label = str_tools.crop(label, max_msg_size) else: include_break = True diff --git a/nyxrc.sample b/nyxrc.sample index 186df2b..dfb9873 100644 --- a/nyxrc.sample +++ b/nyxrc.sample @@ -73,13 +73,15 @@ features.confirmQuit true # preconfigured regular expression pattern, up to five will be loaded features.log.showDuplicateEntries false -features.log.maxLinesPerEntry 6 +features.log.maxLineWrap 6 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$ +features.torrc.maxLineWrap 8 + # Paremters for the config panel # --------------------------- # order

1 0

[nyx/master] Rewrite torrc panel
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 66cb24b9be8ae2d57361312a9ec2e039399af536 Merge: 53fbe02 42c19c2 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Feb 9 21:09:34 2016 -0800 Rewrite torrc panel Only noticeable change is that we're dropping torrc validation. This has always confused users and been the #1 support question on irc. As discussed in other commits power users don't want this and newbies find it puzzling so better off without it. nyx/config/attributes.cfg | 94 ------ nyx/config/dedup.cfg | 91 ------ nyx/config/strings.cfg | 107 ------- nyx/config/torrc.cfg | 53 ---- nyx/controller.py | 18 +- nyx/graph_panel.py | 1 - nyx/log_panel.py | 36 +-- nyx/menu/actions.py | 7 +- nyx/popups.py | 20 +- nyx/settings/attributes.cfg | 94 ++++++ nyx/settings/dedup.cfg | 91 ++++++ nyx/settings/strings.cfg | 109 +++++++ nyx/starter.py | 2 +- nyx/torrc_panel.py | 354 ++++++--------------- nyx/util/__init__.py | 25 +- nyx/util/panel.py | 31 +- nyx/util/tor_config.py | 541 -------------------------------- nyxrc.sample | 23 +- setup.py | 2 +- test/arguments.py | 8 +- test/util/expand_path.py | 21 ++ test/util/tracker/connection_tracker.py | 9 +- 22 files changed, 491 insertions(+), 1246 deletions(-)

1 0

[nyx/master] Finish rewriting torrc panel's draw method
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 42c19c2664938656edc8319cf4bec809ba2662a2 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Feb 9 20:59:19 2016 -0800 Finish rewriting torrc panel's draw method Only functional change is that we no longer overwrite the title while scrolling. This panel is small enough now that there's no need to split up the draw method. --- nyx/menu/actions.py | 6 +-- nyx/torrc_panel.py | 129 ++++++++++++++++++++++------------------------------ 2 files changed, 57 insertions(+), 78 deletions(-) diff --git a/nyx/menu/actions.py b/nyx/menu/actions.py index b6a4ae3..1bbb71a 100644 --- a/nyx/menu/actions.py +++ b/nyx/menu/actions.py @@ -291,10 +291,10 @@ def make_torrc_menu(torrc_panel): torrc_menu = nyx.menu.item.Submenu('Torrc') - if torrc_panel.strip_comments: - label, arg = 'Show', True - else: + if torrc_panel._show_comments: label, arg = 'Hide', False + else: + label, arg = 'Show', True torrc_menu.add(nyx.menu.item.MenuItem('%s Comments' % label, functools.partial(torrc_panel.set_comments_visible, arg))) diff --git a/nyx/torrc_panel.py b/nyx/torrc_panel.py index 1958b4e..260be1f 100644 --- a/nyx/torrc_panel.py +++ b/nyx/torrc_panel.py @@ -22,24 +22,16 @@ class TorrcPanel(panel.Panel): self._scroll = 0 self._show_line_numbers = True # shows left aligned line numbers - self._strip_comments = False # drops comments and extra whitespace - - # height of the content when last rendered (the cached value is invalid if - # _last_content_height_args is None or differs from the current dimensions) - + self._show_comments = True # shows comments and extra whitespace self._last_content_height = 0 self._torrc_location = None self._torrc_content = None self._torrc_load_error = None - # listens for tor reload (sighup) events - controller = tor_controller() controller.add_status_listener(self.reset_listener) - - if controller.is_alive(): - self.reset_listener(controller, State.RESET, None) + self.reset_listener(controller, State.RESET, None) def reset_listener(self, controller, event_type, _): """ @@ -51,7 +43,7 @@ class TorrcPanel(panel.Panel): self._torrc_location = expand_path(controller.get_info('config-file')) with open(self._torrc_location) as torrc_file: - self._torrc_content = [ui_tools.get_printable(line.replace('\t', ' ')) for line in torrc_file.readlines()] + self._torrc_content = [ui_tools.get_printable(line.replace('\t', ' ')).rstrip() for line in torrc_file.readlines()] except ControllerError as exc: self._torrc_load_error = msg('panel.torrc.unable_to_find_torrc', error = exc) self._torrc_location = None @@ -64,19 +56,17 @@ class TorrcPanel(panel.Panel): """ Sets if comments and blank lines are shown or stripped. - Arguments: - is_visible - displayed comments and blank lines if true, strips otherwise + :var bool is_visible: shows comments if true, strips otherwise """ - self._strip_comments = not is_visible + self._show_comments = is_visible self.redraw(True) def set_line_number_visible(self, is_visible): """ Sets if line numbers are shown or hidden. - Arguments: - is_visible - displays line numbers if true, hides otherwise + :var bool is_visible: displays line numbers if true, hides otherwise """ self._show_line_numbers = is_visible @@ -93,7 +83,7 @@ class TorrcPanel(panel.Panel): elif key.match('n'): self.set_line_number_visible(not self._show_line_numbers) elif key.match('s'): - self.set_comments_visible(self._strip_comments) + self.set_comments_visible(not self._show_comments) else: return False @@ -105,87 +95,76 @@ class TorrcPanel(panel.Panel): ('down arrow', 'scroll down a line', None), ('page up', 'scroll up a page', None), ('page down', 'scroll down a page', None), - ('s', 'comment stripping', 'on' if self._strip_comments else 'off'), + ('s', 'comment stripping', 'off' if self._show_comments else 'on'), ('n', 'line numbering', 'on' if self._show_line_numbers else 'off'), ('x', 'reset tor (issue sighup)', None), ] def draw(self, width, height): - if self.is_title_visible(): - location = ' (%s)' % self._torrc_location if self._torrc_location else '' - self.addstr(0, 0, 'Tor Configuration File%s:' % location, curses.A_STANDOUT) - if self._torrc_content is None: self.addstr(1, 0, self._torrc_load_error, 'red', curses.A_BOLD) - return - - self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - - if not self._show_line_numbers: - line_number_offset = 0 - elif len(self._torrc_content) == 0: - line_number_offset = 2 + new_content_height = 1 else: - line_number_offset = int(math.log10(len(self._torrc_content))) + 2 + self._scroll = max(0, min(self._scroll, self._last_content_height - height + 1)) - scroll_offset = 0 - - if self._last_content_height > height - 1: - scroll_offset = 3 - self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) - - y = 1 - self._scroll - is_multiline = False # true if we're in the middle of a multiline torrc entry - - for line_number, line in enumerate(self._torrc_content): - if self._strip_comments: - line = line[:line.find('#')].rstrip() if '#' in line else line.rstrip() + if not self._show_line_numbers: + line_number_offset = 0 + elif len(self._torrc_content) == 0: + line_number_offset = 2 + else: + line_number_offset = int(math.log10(len(self._torrc_content))) + 2 - if not line: - continue # skip blank lines + scroll_offset = 0 - option, argument, comment = '', '', '' + if self._last_content_height > height - 1: + scroll_offset = 3 + self.add_scroll_bar(self._scroll, self._scroll + height - 1, self._last_content_height, 1) - if '#' in line: - line, comment = line.split('#', 1) - comment = '#' + comment + y = 1 - self._scroll + is_multiline = False # true if we're in the middle of a multiline torrc entry - # splits the option and argument, preserving any whitespace around them + for line_number, line in enumerate(self._torrc_content): + if not self._show_comments: + line = line[:line.find('#')].rstrip() if '#' in line else line - stripped_line = line.strip() - option_index = stripped_line.find(' ') + if not line: + continue # skip blank lines - if is_multiline: - argument = line # previous line ended with a '\' - elif option_index == -1: - option = line # no argument provided - else: - option_text = stripped_line[:option_index] - option_end = line.find(option_text) + len(option_text) + if '#' in line: + line, comment = line.split('#', 1) + comment = '#' + comment + else: + comment = '' - option = line[:option_end] - argument = line[option_end:] + if is_multiline: + option, argument = '', line # previous line ended with a '\' + elif ' ' not in line.strip(): + option, argument = line, '' # no argument + else: + whitespace = ' ' * (len(line) - len(line.strip())) + option, argument = line.strip().split(' ', 1) + option = whitespace + option + ' ' - # flags following lines as belonging to this multiline entry if it ends - # with a slash + is_multiline = line.endswith('\\') # next line's part of a multi-line entry - is_multiline = stripped_line.endswith('\\') + if self._show_line_numbers: + self.addstr(y, scroll_offset, str(line_number + 1).rjust(line_number_offset - 1), curses.A_BOLD, 'yellow') - # draws the line number + x = line_number_offset + scroll_offset + min_x = line_number_offset + scroll_offset - if self._show_line_numbers and y < height and y >= 1: - self.addstr(y, scroll_offset, str(line_number + 1).rjust(line_number_offset - 1), curses.A_BOLD, 'yellow') + x, y = self.addstr_wrap(y, x, option, width, min_x, curses.A_BOLD, 'green') + x, y = self.addstr_wrap(y, x, argument, width, min_x, curses.A_BOLD, 'cyan') + x, y = self.addstr_wrap(y, x, comment, width, min_x, 'white') - x = line_number_offset + scroll_offset - min_x = line_number_offset + scroll_offset + y += 1 - x, y = self.addstr_wrap(y, x, option, width, min_x, curses.A_BOLD, 'green') - x, y = self.addstr_wrap(y, x, argument, width, min_x, curses.A_BOLD, 'cyan') - x, y = self.addstr_wrap(y, x, comment, width, min_x, 'white') + new_content_height = y + self._scroll - 1 - y += 1 - - new_content_height = y + self._scroll - 1 + if self.is_title_visible(): + self.addstr(0, 0, ' ' * width) # clear line + location = ' (%s)' % self._torrc_location if self._torrc_location else '' + self.addstr(0, 0, 'Tor Configuration File%s:' % location, curses.A_STANDOUT) if self._last_content_height != new_content_height: self._last_content_height = new_content_height

1 0

[stem/master] Updating with new config options
by atagar＠torproject.org 14 Feb '16

14 Feb '16

commit 645017a5f8c17b143e90602fdfe6c03a1a994a1c Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 13 18:53:52 2016 -0800 Updating with new config options Just pulling in the latest torrc changes, most notably the addition of ClientUseIPv4 and ClientPreferIPv6DirPort... https://gitweb.torproject.org/tor.git/commit/?id=2d33d19 --- stem/cached_tor_manual.cfg | 26 +++++++++++++++++++------- stem/settings.cfg | 4 +++- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/stem/cached_tor_manual.cfg b/stem/cached_tor_manual.cfg index 4866251..7a98873 100644 --- a/stem/cached_tor_manual.cfg +++ b/stem/cached_tor_manual.cfg @@ -6,8 +6,8 @@ description |Basically, Tor provides a distributed network of servers or relays ("onion routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc. -- around the network, and recipients, observers, and even the relays themselves have difficulty tracking the source of the stream. | |By default, tor will only act as a client only. To help the network by providing bandwidth as a relay, change the ORPort configuration option -- see below. Please also consult the documentation on the Tor Project's website. -man_commit a5bed4dab2f8521f744d5137e4f439b073c7e5e9 -stem_commit 5b8b5ca5dc3cd2c0797c10910d6826e274651ff5 +man_commit ba2be81fc36ba6140247873799b747605fb07bd4 +stem_commit fc35ea1a74b6f9a95b6d1c2d21069f837dc725bb commandline_options -f FILE => Specify a new configuration file to contain further Tor configuration options OR pass - to make Tor read its configuration from standard input. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not found) commandline_options --ignore-missing-torrc => Specifies that Tor should treat a missing torrc file as though it were empty. Ordinarily, Tor does this for missing default torrc files, but not for those specified on the command line. commandline_options --list-fingerprint => Generate your keys and output your nickname and fingerprint. @@ -630,16 +630,26 @@ config_options.PathBiasScaleUseThreshold.description |Where as the path bias parameters govern thresholds for successfully building circuits, these four path use bias parameters govern thresholds only for circuit usage. Circuits which receive no stream usage are not counted by this detection algorithm. A used circuit is considered successful if it is capable of carrying streams or otherwise receiving well-formed responses to RELAY cells. | |By default, or if a negative value is provided for one of these options, Tor uses reasonable defaults from the networkstatus consensus document. If no defaults are available there, these options default to 20, .80, .60, and 100, respectively. +config_options.ClientUseIPv4.category Client +config_options.ClientUseIPv4.name ClientUseIPv4 +config_options.ClientUseIPv4.usage 0|1 +config_options.ClientUseIPv4.summary Allow IPv4 connections to guards and fetching consensus +config_options.ClientUseIPv4.description If this option is set to 0, Tor will avoid connecting to directory servers and entry nodes over IPv4. Note that clients with an IPv4 address in a Bridge, proxy, or pluggable transport line will try connecting over IPv4 even if ClientUseIPv4 is set to 0. (Default: 1) config_options.ClientUseIPv6.category Client config_options.ClientUseIPv6.name ClientUseIPv6 config_options.ClientUseIPv6.usage 0|1 -config_options.ClientUseIPv6.summary Allow IPv6 connections to guards -config_options.ClientUseIPv6.description If this option is set to 1, Tor might connect to entry nodes over IPv6. Note that clients configured with an IPv6 address in a Bridge line will try connecting over IPv6 even if ClientUseIPv6 is set to 0. (Default: 0) +config_options.ClientUseIPv6.summary Allow IPv6 connections to guards and fetching consensus +config_options.ClientUseIPv6.description If this option is set to 1, Tor might connect to directory servers or entry nodes over IPv6. Note that clients configured with an IPv6 address in a Bridge, proxy, or pluggable transport line will try connecting over IPv6 even if ClientUseIPv6 is set to 0. (Default: 0) +config_options.ClientPreferIPv6DirPort.category Client +config_options.ClientPreferIPv6DirPort.name ClientPreferIPv6DirPort +config_options.ClientPreferIPv6DirPort.usage 0|1|auto +config_options.ClientPreferIPv6DirPort.summary Perfer relays with IPv6 when fetching consensus +config_options.ClientPreferIPv6DirPort.description If this option is set to 1, Tor prefers a directory port with an IPv6 address over one with IPv4, for direct connections, if a given directory server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to 0.) If this option is set to auto, clients prefer IPv4. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: auto) config_options.ClientPreferIPv6ORPort.category Client config_options.ClientPreferIPv6ORPort.name ClientPreferIPv6ORPort -config_options.ClientPreferIPv6ORPort.usage 0|1 +config_options.ClientPreferIPv6ORPort.usage 0|1|auto config_options.ClientPreferIPv6ORPort.summary Prefer a guard's IPv6 rather than IPv4 endpoint -config_options.ClientPreferIPv6ORPort.description If this option is set to 1, Tor prefers an OR port with an IPv6 address over one with IPv4 if a given entry node has both. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: 0) +config_options.ClientPreferIPv6ORPort.description If this option is set to 1, Tor prefers an OR port with an IPv6 address over one with IPv4 if a given entry node has both. (Tor also prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set to auto, Tor bridge clients prefer the configured bridge address, and other clients prefer IPv4. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: auto) config_options.PathsNeededToBuildCircuits.category Client config_options.PathsNeededToBuildCircuits.name PathsNeededToBuildCircuits config_options.PathsNeededToBuildCircuits.usage NUM @@ -859,7 +869,7 @@ config_options.FallbackDir.category General config_options.FallbackDir.name FallbackDir config_options.FallbackDir.usage address:port orport=port id=fingerprint [weight=num] [ipv6=address:orport] config_options.FallbackDir.summary Fallback when unable to retrieve descriptor information -config_options.FallbackDir.description When we're unable to connect to any directory cache for directory info (usually because we don't know about any yet) we try a directory authority. Clients also simultaneously try a FallbackDir, to avoid hangs on client startup if a directory authority is down. Clients retry FallbackDirs more often than directory authorities, to reduce the load on the directory authorities. By default, the directory authorities are also FallbackDirs. Specifying a FallbackDir replaces Tor's default hard-coded FallbackDirs (if any). +config_options.FallbackDir.description When we're unable to connect to any directory cache for directory info (usually because we don't know about any yet) we try a directory authority. Clients also simultaneously try a FallbackDir, to avoid hangs on client startup if a directory authority is down. Clients retry FallbackDirs more often than directory authorities, to reduce the load on the directory authorities. By default, the directory authorities are also FallbackDirs. Specifying a FallbackDir replaces Tor's default hard-coded FallbackDirs (if any). (See the DirAuthority entry for an explanation of each flag.) config_options.UseDefaultFallbackDirs.category General config_options.UseDefaultFallbackDirs.name UseDefaultFallbackDirs config_options.UseDefaultFallbackDirs.usage 0|1 @@ -872,6 +882,8 @@ config_options.DirAuthority.summary Alternative directory authorities config_options.DirAuthority.description |Use a nonstandard authoritative directory server at the provided address and port, with the specified key fingerprint. This option can be repeated many times, for multiple authoritative directory servers. Flags are separated by spaces, and determine what kind of an authority this directory is. By default, an authority is not authoritative for any directory style or version unless an appropriate flag is given. Tor will use this authority as a bridge authoritative directory if the "bridge" flag is set. If a flag "orport=port" is given, Tor will use the given port when opening encrypted tunnels to the dirserver. If a flag "weight=num" is given, then the directory server is chosen randomly with probability proportional to that weight (default 1.0). If a flag "v3ident=fp" is given, the dirserver is a v3 directory authority whose v3 long-term signing key has the fingerprint fp. Lastly, if an "ipv6=address:orport" flag is present, then the directory authority is listening for IPv6 connect ions on the indicated IPv6 address and OR Port. | +|Tor will contact the authority at address:port (the DirPort) to download directory documents. If an IPv6 address is supplied, Tor will also download directory documents at the IPv6 address on the DirPort. +| |If no DirAuthority line is given, Tor will use the default directory authorities. NOTE: this option is intended for setting up a private Tor network with its own directory authorities. If you use it, you will be distinguishable from other users, because you won't believe the same authorities they do. config_options.DirAuthorityFallbackRate.category General config_options.DirAuthorityFallbackRate.name DirAuthorityFallbackRate diff --git a/stem/settings.cfg b/stem/settings.cfg index 82e8f88..cc90be6 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -205,7 +205,9 @@ manual.summary.PathBiasUseThreshold Number of streams through a circuit before a manual.summary.PathBiasNoticeUseRate Fraction of streams that must succeed before logging a notice manual.summary.PathBiasExtremeUseRate Fraction of streams that must succeed before logging an error manual.summary.PathBiasScaleUseThreshold Streams through a circuit before scaling past observations down -manual.summary.ClientUseIPv6 Allow IPv6 connections to guards +manual.summary.ClientUseIPv4 Allow IPv4 connections to guards and fetching consensus +manual.summary.ClientUseIPv6 Allow IPv6 connections to guards and fetching consensus +manual.summary.ClientPreferIPv6DirPort Perfer relays with IPv6 when fetching consensus manual.summary.ClientPreferIPv6ORPort Prefer a guard's IPv6 rather than IPv4 endpoint manual.summary.PathsNeededToBuildCircuits Portion of relays to require information for before making circuits

1 0