- tor-commits - lists.torproject.org

[nyx/master] Simplify dialog for writing our torrc
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 564dee17c36bef3c0a4fba72e76b495cfa1d8e1c Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 3 12:54:06 2016 -0800 Simplify dialog for writing our torrc During the Nyx rewrite I've been making ourself less catering to extremely weird situations. One of those is screens that are less that twenty columns wide. Silly to have special logic elongating our dialog just for that. Also, dialog now closes when you press 'esc'. --- nyx/config_panel.py | 54 +++++++++++++++++---------------------------------- nyx/popups.py | 2 +- 2 files changed, 19 insertions(+), 37 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index dfb6188..eb12999 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -169,23 +169,14 @@ class ConfigPanel(panel.Panel): Confirmation dialog for saving tor's configuration. """ - config_text = tor_controller().get_info('config-text', None) + selection, controller = 1, tor_controller() + config_text = controller.get_info('config-text', None) config_lines = config_text.splitlines() if config_text else [] with nyx.popups.popup_window(len(config_lines) + 2) as (popup, width, height): if not popup or height <= 2: return - # Try showing options beside the last config line. If there isn't room - # and we can grow vertically then do that so it's on their own line. - - if width < (len(config_lines[height - 3]) + 30): - popup.set_height(height + 1) - popup.redraw(True) # recreates the window instance - height = popup.get_preferred_size()[0] - - selection = 1 - while True: height, width = popup.get_preferred_size() # allow us to be resized popup.win.erase() @@ -197,26 +188,15 @@ class ConfigPanel(panel.Panel): popup.addstr(i + 1, 1, option, curses.A_BOLD, 'green') popup.addstr(i + 1, len(option) + 2, arg, curses.A_BOLD, 'cyan') - # selection options (drawn right to left) - - selection_options = ('Save', 'Cancel') - draw_x = width - 1 - - for option in reversed(selection_options): - draw_x -= len(option) + 2 + x = width - 16 - if draw_x < 1: - break # not enough room to show all options - - option_format = curses.A_STANDOUT if option == selection_options[selection] else curses.A_NORMAL - x = popup.addstr(height - 2, draw_x, '[') - x = popup.addstr(height - 2, x, option, option_format, curses.A_BOLD) - popup.addstr(height - 2, x, ']') - - draw_x -= 1 # gap between options + for i, option in enumerate(['Save', 'Cancel']): + x = popup.addstr(height - 2, x, '[') + x = popup.addstr(height - 2, x, option, curses.A_BOLD, curses.A_STANDOUT if i == selection else curses.A_NORMAL) + x = popup.addstr(height - 2, x, '] ') popup.win.box() - popup.addstr(0, 0, 'Torrc configuration to save:', curses.A_STANDOUT) + popup.addstr(0, 0, 'Torrc to save:', curses.A_STANDOUT) popup.win.refresh() key = nyx.controller.get_controller().key_input() @@ -224,16 +204,18 @@ class ConfigPanel(panel.Panel): if key.match('left'): selection = max(0, selection - 1) elif key.match('right'): - selection = min(len(selection_options) - 1, selection + 1) + selection = min(1, selection + 1) elif key.is_selection(): - break + if selection == 0: + try: + controller.save_conf() + nyx.popups.show_msg('Saved configuration to %s' % controller.get_info('config-file', '<unknown>'), 2) + except IOError as exc: + nyx.popups.show_msg('Unable to save configuration (%s)' % exc.strerror, 2) - if selection == 0: - try: - tor_controller().save_conf() - nyx.popups.show_msg('Saved configuration to %s' % controller.get_info('config-file', '<unknown>'), 2) - except IOError as exc: - nyx.popups.show_msg('Unable to save configuration (%s)' % exc.strerror, 2) + break + elif key.match('esc'): + break # esc - cancel def handle_key(self, key): if key.is_scroll(): diff --git a/nyx/popups.py b/nyx/popups.py index 0e46ba6..017b672 100644 --- a/nyx/popups.py +++ b/nyx/popups.py @@ -333,7 +333,7 @@ def show_sort_dialog(title, options, old_selection, option_colors): new_selections.append(selection) selection_options.remove(selection) cursor_location = min(cursor_location, len(selection_options) - 1) - elif key == 27: + elif key.match('esc'): break # esc - cancel if len(new_selections) == len(old_selection):

1 0

[nyx/master] Rewrite _draw_selection_details()
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit b6c689cf2708a63e10be9c0e097ee271830a29ef Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 3 17:33:47 2016 -0800 Rewrite _draw_selection_details() Simplify our draw helper. Much cleaner... --- nyx/config_panel.py | 80 +++++++++++++-------------------------------------- 1 file changed, 20 insertions(+), 60 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index 981da7d..eb51ba3 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -276,7 +276,10 @@ class ConfigPanel(panel.Panel): is_scrollbar_visible = len(contents) > height - DETAILS_HEIGHT if selection is not None: - self._draw_selection_panel(selection, width, is_scrollbar_visible) + self._draw_selection_details(selection, width) + + if is_scrollbar_visible: + self.addch(DETAILS_HEIGHT - 1, 1, curses.ACS_TTEE) if self.is_title_visible(): hidden_msg = "press 'a' to hide most options" if self._show_all else "press 'a' to show all options" @@ -325,71 +328,28 @@ class ConfigPanel(panel.Panel): def _get_config_options(self): return self._contents if self._show_all else filter(lambda entry: stem.manual.is_important(entry.name) or entry.is_set(), self._contents) - def _draw_selection_panel(self, selection, width, is_scrollbar_visible): + def _draw_selection_details(self, selection, width): """ - Renders a panel for the selected configuration option. + Shows details of the currently selected option. """ - # This is a solid border unless the scrollbar is visible, in which case a - # 'T' pipe connects the border to the bar. - + description = 'Description: %s' % (selection.manual.description) + attr = ', '.join(('custom' if selection.is_set() else 'default', selection.value_type, 'usage: %s' % selection.manual.usage)) + selected_color = CONFIG['attr.config.category_color'].get(selection.manual.category, 'white') ui_tools.draw_box(self, 0, 0, width, DETAILS_HEIGHT) - if is_scrollbar_visible: - self.addch(DETAILS_HEIGHT - 1, 1, curses.ACS_TTEE) - - selection_format = (curses.A_BOLD, CONFIG['attr.config.category_color'].get(selection.manual.category, 'white')) - - # first entry: - # <option> (<category> Option) - - option_label = ' (%s Option)' % selection.manual.category - self.addstr(1, 2, selection.name + option_label, *selection_format) - - # second entry: - # Value: <value> ([default|custom], <type>, usage: <argument usage>) - - if DETAILS_HEIGHT >= 4: - value_attr_label = ', '.join([ - 'custom' if selection.is_set() else 'default', - selection.value_type, - 'usage: %s' % (selection.manual.usage) - ]) - - value_label_width = max(0, width - 12 - len(value_attr_label)) - value_label = str_tools.crop(selection.value(), value_label_width) - - self.addstr(2, 2, 'Value: %s (%s)' % (value_label, value_attr_label), *selection_format) + self.addstr(1, 2, '%s (%s Option)' % (selection.name, selection.manual.category), curses.A_BOLD, selected_color) + self.addstr(2, 2, 'Value: %s (%s)' % (selection.value(), str_tools.crop(attr, width - len(selection.value()) - 13)), curses.A_BOLD, selected_color) - # remainder is filled with the man page description + for i in range(DETAILS_HEIGHT - 4): + if not description: + break # done writing description - description_height = max(0, DETAILS_HEIGHT - 4) - description_content = 'Description: %s' % (selection.manual.description) + line, description = description.split('\n', 1) if '\n' in description else (description, '') - for i in range(description_height): - if not description_content: - break # done writing the description - - # there's a leading indent after the first line - - if i > 0: - description_content = ' ' + description_content - - # we only want to work with content up until the next newline - - if '\n' in description_content: - line_content, description_content = description_content.split('\n', 1) + if i < DETAILS_HEIGHT - 5: + line, remainder = str_tools.crop(line, width - 3, 4, 4, str_tools.Ending.HYPHEN, True) + description = ' ' + remainder.strip() + description + self.addstr(3 + i, 2, line, curses.A_BOLD, selected_color) else: - line_content, description_content = description_content, '' - - if i != description_height - 1: - # there's more lines to display - - msg, remainder = str_tools.crop(line_content, width - 3, 4, 4, str_tools.Ending.HYPHEN, True) - description_content = remainder.strip() + description_content - else: - # this is the last line, end it with an ellipse - - msg = str_tools.crop(line_content, width - 3, 4, 4) - - self.addstr(3 + i, 2, msg, *selection_format) + self.addstr(3 + i, 2, str_tools.crop(line, width - 3, 4, 4), curses.A_BOLD, selected_color)

1 0

[nyx/master] Always show modified config options in panel
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit a68979dd009cbff62f2811a2357f9f1455d477d0 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 3 15:57:10 2016 -0800 Always show modified config options in panel In addition to showing important options, showing anything that's modified in the panel too. If users have set it obviously they're important. ;) Turns out the previous method we were using to see if options were set was completely broken. Using the new method stem provides to do this. --- nyx/config_panel.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index eb12999..47d25b8 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -78,7 +78,7 @@ class ConfigEntry(object): :returns: **True** if the option has a custom value, **False** otherwise """ - return bool(tor_controller().get_conf(self.name, None)) + return tor_controller().is_set(self.name, False) def sort_value(self, attr): """ @@ -265,7 +265,7 @@ class ConfigPanel(panel.Panel): ('page down', 'scroll down a page', None), ('enter', 'edit configuration option', None), ('w', 'write torrc', None), - ('a', 'toggle option filtering', None), + ('a', 'toggle filtering', None), ('s', 'sort ordering', None), ] @@ -328,7 +328,7 @@ class ConfigPanel(panel.Panel): break def _get_config_options(self): - return self._contents if self._show_all else filter(lambda entry: stem.manual.is_important(entry.name), self._contents) + return self._contents if self._show_all else filter(lambda entry: stem.manual.is_important(entry.name) or entry.is_set(), self._contents) def _draw_selection_panel(self, selection, width, detail_panel_height, is_scrollbar_visible): """

1 0

[nyx/master] Tidy up config panel's draw() method
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 96e14974119da71b8682b1ff8c889cd5ad982f89 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 4 09:35:34 2016 -0800 Tidy up config panel's draw() method Last bit of the config panel! Just revising bits to be a bit more concise. --- nyx/config_panel.py | 47 +++++++++++++++++++---------------------------- nyx/util/tor_config.py | 2 -- 2 files changed, 19 insertions(+), 30 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index eb51ba3..8f71861 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -278,15 +278,9 @@ class ConfigPanel(panel.Panel): if selection is not None: self._draw_selection_details(selection, width) - if is_scrollbar_visible: - self.addch(DETAILS_HEIGHT - 1, 1, curses.ACS_TTEE) - if self.is_title_visible(): hidden_msg = "press 'a' to hide most options" if self._show_all else "press 'a' to show all options" - title_label = 'Tor Configuration (%s):' % hidden_msg - self.addstr(0, 0, title_label, curses.A_STANDOUT) - - # draws left-hand scroll bar if content's longer than the height + self.addstr(0, 0, 'Tor Configuration (%s):' % hidden_msg, curses.A_STANDOUT) scroll_offset = 1 @@ -294,35 +288,32 @@ class ConfigPanel(panel.Panel): scroll_offset = 3 self.add_scroll_bar(scroll_location, scroll_location + height - DETAILS_HEIGHT, len(contents), DETAILS_HEIGHT) - value_width = VALUE_WIDTH - description_width = max(0, width - scroll_offset - NAME_WIDTH - value_width - 2) + if selection is not None: + self.addch(DETAILS_HEIGHT - 1, 1, curses.ACS_TTEE) + + # Description column can grow up to eighty characters. After that any extra + # space goes to the value. - # if the description column is overly long then use its space for the - # value instead + description_width = max(0, width - scroll_offset - NAME_WIDTH - VALUE_WIDTH - 2) if description_width > 80: - value_width += description_width - 80 + value_width = VALUE_WIDTH + (description_width - 80) description_width = 80 + else: + value_width = VALUE_WIDTH - for line_number in range(scroll_location, len(contents)): - entry = contents[line_number] - draw_line = line_number + DETAILS_HEIGHT - scroll_location - - line_format = [curses.A_BOLD if entry.is_set() else curses.A_NORMAL] - line_format += [CONFIG['attr.config.category_color'].get(entry.manual.category, 'white')] - - if entry == selection: - line_format += [curses.A_STANDOUT] + for i, entry in enumerate(contents[scroll_location:]): + attr = nyx.util.ui_tools.get_color(CONFIG['attr.config.category_color'].get(entry.manual.category, 'white')) + attr |= curses.A_BOLD if entry.is_set() else curses.A_NORMAL + attr |= curses.A_STANDOUT if entry == selection else curses.A_NORMAL - option_label = str_tools.crop(entry.name, NAME_WIDTH) - value_label = str_tools.crop(entry.value(), value_width) - summary_label = str_tools.crop(entry.manual.summary, description_width, None) - line_text_layout = '%%-%is %%-%is %%-%is' % (NAME_WIDTH, value_width, description_width) - line_text = line_text_layout % (option_label, value_label, summary_label) + option_label = str_tools.crop(entry.name, NAME_WIDTH).ljust(NAME_WIDTH + 1) + value_label = str_tools.crop(entry.value(), value_width).ljust(value_width + 1) + summary_label = str_tools.crop(entry.manual.summary, description_width).ljust(description_width) - self.addstr(draw_line, scroll_offset, line_text, *line_format) + self.addstr(DETAILS_HEIGHT + i, scroll_offset, option_label + value_label + summary_label, attr) - if draw_line >= height: + if DETAILS_HEIGHT + i >= height: break def _get_config_options(self): diff --git a/nyx/util/tor_config.py b/nyx/util/tor_config.py index 56c6a7f..4749223 100644 --- a/nyx/util/tor_config.py +++ b/nyx/util/tor_config.py @@ -2,8 +2,6 @@ Helper functions for working with tor's configuration file. """ -import os -import time import threading import stem.version

1 0

[nyx/master] Rewrite configuration panel
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit eb8a35e6dfa7f2c830483a15c8399cc172ff1ba7 Merge: 97f1f94 96e1497 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 4 09:45:20 2016 -0800 Rewrite configuration panel Better! Panel is a hell of a lot simpler and now uses stem's stem.manual module. This is a lot quicker than nyx's variant, and with information that's no longer years out of date. nyx/__init__.py | 6 +- nyx/config/attributes.cfg | 17 + nyx/config/torrc.cfg | 260 -------------- nyx/config_panel.py | 794 +++++++++++------------------------------ nyx/connection_panel.py | 17 +- nyx/controller.py | 2 +- nyx/graph_panel.py | 8 +- nyx/menu/actions.py | 8 - nyx/popups.py | 62 ++-- nyx/starter.py | 12 +- nyx/util/__init__.py | 18 +- nyx/util/tor_config.py | 566 +---------------------------- nyxrc.sample | 32 +- test/settings.cfg | 1 + test/util/log/read_tor_log.py | 12 +- 15 files changed, 313 insertions(+), 1502 deletions(-)

1 0

[nyx/master] Change is_unset() to is_set()
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 69376cc09ca3e6a8c60c6a46a038e89b7edf6a2b Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 26 00:31:27 2015 -0700 Change is_unset() to is_set() Negative values are odd for getters, providing the inverse. --- nyx/config_panel.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index 6d80234..cfa6e62 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -119,14 +119,12 @@ class ConfigEntry(): return self.label_cache - def is_unset(self): + def is_set(self): """ - True if we have no value, false otherwise. + True if we have a custom value, false otherwise. """ - conf_value = tor_controller().get_conf(self.get(Field.OPTION), [], True) - - return not bool(conf_value) + return bool(tor_controller().get_conf(self.get(Field.OPTION), [], True)) def _get_value(self): """ @@ -299,7 +297,7 @@ class ConfigPanel(panel.Panel): selection = self.get_selection() config_option = selection.get(Field.OPTION) - initial_value = '' if selection.is_unset() else selection.get(Field.VALUE) + initial_value = '' if not selection.is_set() else selection.get(Field.VALUE) prompt_msg = '%s Value (esc to cancel): ' % config_option is_prepopulated = CONFIG['features.config.prepopulateEditValues'] new_value = nyx.popups.input_prompt(prompt_msg, initial_value if is_prepopulated else '')

1 0

[nyx/master] Move field attributes to configuration
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 8ad0e0b87f95555775a0ddb5c0df5f12dde67ba1 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Sep 25 14:13:00 2015 -0700 Move field attributes to configuration As with elsewhere moving our color mappings to our configuration to get it out of the code. Also changing the Fields enum to use labels for their values (as we ususally do with enumerations). This was probably separate so we could use the shorter name in the nyxrc, but those can use the label names. --- nyx/config/attributes.cfg | 17 +++++++++++ nyx/config_panel.py | 71 +++++++++++---------------------------------- nyxrc.sample | 20 ++++++------- 3 files changed, 44 insertions(+), 64 deletions(-) diff --git a/nyx/config/attributes.cfg b/nyx/config/attributes.cfg index e1d1b9e..39faa1e 100644 --- a/nyx/config/attributes.cfg +++ b/nyx/config/attributes.cfg @@ -75,3 +75,20 @@ attr.connection.sort_color Fingerprint => cyan attr.connection.sort_color Nickname => cyan attr.connection.sort_color Country => blue +attr.config.category_color General => green +attr.config.category_color Client => blue +attr.config.category_color Relay => yellow +attr.config.category_color Directory => magenta +attr.config.category_color Authority => red +attr.config.category_color Hidden Service => cyan +attr.config.category_color Testing => white +attr.config.category_color Unknown => white + +attr.config.field_color Category => red +attr.config.field_color Option Name => blue +attr.config.field_color Value => cyan +attr.config.field_color Arg Type => green +attr.config.field_color Arg Usage => yellow +attr.config.field_color Summary => green +attr.config.field_color Description => white +attr.config.field_color Man Page Entry => blue diff --git a/nyx/config_panel.py b/nyx/config_panel.py index 64552f1..3ef4a4e 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -15,45 +15,20 @@ import stem.control from stem.util import conf, enum, str_tools -# mappings of option categories to the color for their entries - -CATEGORY_COLOR = { - tor_config.Category.GENERAL: 'green', - tor_config.Category.CLIENT: 'blue', - tor_config.Category.RELAY: 'yellow', - tor_config.Category.DIRECTORY: 'magenta', - tor_config.Category.AUTHORITY: 'red', - tor_config.Category.HIDDEN_SERVICE: 'cyan', - tor_config.Category.TESTING: 'white', - tor_config.Category.UNKNOWN: 'white', -} - # attributes of a ConfigEntry Field = enum.Enum( - 'CATEGORY', - 'OPTION', - 'VALUE', - 'TYPE', - 'ARG_USAGE', - 'SUMMARY', - 'DESCRIPTION', - 'MAN_ENTRY', - 'IS_DEFAULT', + ('CATEGORY', 'Category'), + ('OPTION', 'Option Name'), + ('VALUE', 'Value'), + ('TYPE', 'Arg Type'), + ('ARG_USAGE', 'Arg Usage'), + ('SUMMARY', 'Summary'), + ('DESCRIPTION', 'Description'), + ('MAN_ENTRY', 'Man Page Entry'), + ('IS_DEFAULT', 'Is Default'), ) -FIELD_ATTR = { - Field.CATEGORY: ('Category', 'red'), - Field.OPTION: ('Option Name', 'blue'), - Field.VALUE: ('Value', 'cyan'), - Field.TYPE: ('Arg Type', 'green'), - Field.ARG_USAGE: ('Arg Usage', 'yellow'), - Field.SUMMARY: ('Summary', 'green'), - Field.DESCRIPTION: ('Description', 'white'), - Field.MAN_ENTRY: ('Man Page Entry', 'blue'), - Field.IS_DEFAULT: ('Is Default', 'magenta'), -} - def conf_handler(key, value): if key == 'features.config.selectionDetails.height': @@ -67,6 +42,8 @@ def conf_handler(key, value): CONFIG = conf.config_dict('nyx', { + 'attr.config.category_color': {}, + 'attr.config.field_color': {}, 'features.config.order': [Field.MAN_ENTRY, Field.OPTION, Field.IS_DEFAULT], 'features.config.selectionDetails.height': 6, 'features.config.prepopulateEditValues': True, @@ -77,17 +54,6 @@ CONFIG = conf.config_dict('nyx', { }, conf_handler) -def get_field_from_label(field_label): - """ - Converts field labels back to their enumeration, raising a ValueError if it - doesn't exist. - """ - - for entry_enum in FIELD_ATTR: - if field_label == FIELD_ATTR[entry_enum][0]: - return entry_enum - - class ConfigEntry(): """ Configuration option in the panel. @@ -331,15 +297,12 @@ class ConfigPanel(panel.Panel): # set ordering for config options title_label = 'Config Option Ordering:' - options = [FIELD_ATTR[field][0] for field in Field] - old_selection = [FIELD_ATTR[field][0] for field in CONFIG['features.config.order']] - option_colors = dict([FIELD_ATTR[field] for field in Field]) - results = nyx.popups.show_sort_dialog(title_label, options, old_selection, option_colors) + old_selection = CONFIG['features.config.order'] + option_colors = dict([(field, CONFIG['attr.config.field_color'].get(field, 'white')) for field in Field]) + results = nyx.popups.show_sort_dialog(title_label, Field, old_selection, option_colors) if results: - # converts labels back to enums - result_enums = [get_field_from_label(label) for label in results] - self.set_sort_order(result_enums) + self.set_sort_order(results) def handle_key(self, key): with self._vals_lock: @@ -613,7 +576,7 @@ class ConfigPanel(panel.Panel): line_format = [curses.A_NORMAL if entry.get(Field.IS_DEFAULT) else curses.A_BOLD] if entry.get(Field.CATEGORY): - line_format += [CATEGORY_COLOR[entry.get(Field.CATEGORY)]] + line_format += [CONFIG['attr.config.category_color'].get(entry.get(Field.CATEGORY), 'white')] if entry == cursor_selection: line_format += [curses.A_STANDOUT] @@ -640,7 +603,7 @@ class ConfigPanel(panel.Panel): if is_scrollbar_visible: self.addch(detail_panel_height, 1, curses.ACS_TTEE) - selection_format = (curses.A_BOLD, CATEGORY_COLOR[selection.get(Field.CATEGORY)]) + selection_format = (curses.A_BOLD, CONFIG['attr.config.category_color'].get(selection.get(Field.CATEGORY), 'white')) # first entry: # <option> (<category> Option) diff --git a/nyxrc.sample b/nyxrc.sample index c623de0..666a21e 100644 --- a/nyxrc.sample +++ b/nyxrc.sample @@ -88,15 +88,15 @@ features.log.maxRefreshRate 300 # order # three comma separated configuration attributes, options including: # -# * CATEGORY -# * OPTION -# * VALUE -# * TYPE -# * ARG_USAGE -# * SUMMARY -# * DESCRIPTION -# * MAN_ENTRY -# * IS_DEFAULT +# * Category +# * Option Name +# * Value +# * Arg Type +# * Arg Usage +# * Summary +# * Description +# * Man Page Entry +# * Is Default # # selectionDetails.height # rows of data for the panel showing details on the current selection, this @@ -117,7 +117,7 @@ features.log.maxRefreshRate 300 # file.maxLinesPerEntry # max number of lines to display for a single entry in the torrc -features.config.order MAN_ENTRY, OPTION, IS_DEFAULT +features.config.order Man Page Entry, Option Name, Is Default features.config.selectionDetails.height 6 features.config.prepopulateEditValues true features.config.state.colWidth.option 25

1 0

[nyx/master] Drop config panel's support for alternate types
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 1db1d273267d03f31dae56bb504f3ec10b62cb80 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Sep 25 11:26:08 2015 -0700 Drop config panel's support for alternate types Our config panel had some (but not much) code to support both tor configurations *and* nyx itself. Neat idea, but nyx's config options have never been of much use so I never fully implemented this. Pulling out the dead code. --- nyx/config_panel.py | 57 ++++++++++++++++++--------------------------------- nyx/controller.py | 2 +- 2 files changed, 21 insertions(+), 38 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index 18d76f4..64552f1 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -15,12 +15,6 @@ import stem.control from stem.util import conf, enum, str_tools -# TODO: The nyx use cases are incomplete since they currently can't be -# modified, have their descriptions fetched, or even get a complete listing -# of what's available. - -State = enum.Enum('TOR', 'NYX') # state to be presented - # mappings of option categories to the color for their entries CATEGORY_COLOR = { @@ -218,10 +212,9 @@ class ConfigPanel(panel.Panel): be selected and edited. """ - def __init__(self, stdscr, config_type): + def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, 'configuration', 0) - self.config_type = config_type self.conf_contents = [] self.conf_important_contents = [] self.scroller = ui_tools.Scroller(True) @@ -255,39 +248,30 @@ class ConfigPanel(panel.Panel): self.conf_contents = [] self.conf_important_contents = [] - if self.config_type == State.TOR: - controller, config_option_lines = tor_controller(), [] - custom_options = tor_config.get_custom_options() - config_option_query = controller.get_info('config/names', None) - - if config_option_query: - config_option_lines = config_option_query.strip().split('\n') - - for line in config_option_lines: - # lines are of the form "<option> <type>[ <documentation>]", like: - # UseEntryGuards Boolean - # documentation is aparently only in older versions (for instance, - # 0.2.1.25) - - line_comp = line.strip().split(' ') - conf_option, conf_type = line_comp[0], line_comp[1] + controller, config_option_lines = tor_controller(), [] + custom_options = tor_config.get_custom_options() + config_option_query = controller.get_info('config/names', None) - # skips private and virtual entries if not configured to show them + if config_option_query: + config_option_lines = config_option_query.strip().split('\n') - if not CONFIG['features.config.state.showPrivateOptions'] and conf_option.startswith('__'): - continue - elif not CONFIG['features.config.state.showVirtualOptions'] and conf_type == 'Virtual': - continue + for line in config_option_lines: + # lines are of the form "<option> <type>[ <documentation>]", like: + # UseEntryGuards Boolean + # documentation is aparently only in older versions (for instance, + # 0.2.1.25) - self.conf_contents.append(ConfigEntry(conf_option, conf_type, conf_option not in custom_options)) + line_comp = line.strip().split(' ') + conf_option, conf_type = line_comp[0], line_comp[1] - elif self.config_type == State.NYX: - # loaded via the conf utility + # skips private and virtual entries if not configured to show them - nyx_config = conf.get_config('nyx') + if not CONFIG['features.config.state.showPrivateOptions'] and conf_option.startswith('__'): + continue + elif not CONFIG['features.config.state.showVirtualOptions'] and conf_type == 'Virtual': + continue - for key in nyx_config.keys(): - pass # TODO: implement + self.conf_contents.append(ConfigEntry(conf_option, conf_type, conf_option not in custom_options)) # mirror listing with only the important configuration options @@ -599,9 +583,8 @@ class ConfigPanel(panel.Panel): # draws the top label if self.is_title_visible(): - config_type = 'Tor' if self.config_type == State.TOR else 'Arm' hidden_msg = "press 'a' to hide most options" if self.show_all else "press 'a' to show all options" - title_label = '%s Configuration (%s):' % (config_type, hidden_msg) + title_label = 'Tor Configuration (%s):' % hidden_msg self.addstr(0, 0, title_label, curses.A_STANDOUT) # draws left-hand scroll bar if content's longer than the height diff --git a/nyx/controller.py b/nyx/controller.py index d0fb7d0..7ff6e53 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -150,7 +150,7 @@ def init_controller(stdscr, start_time): # third page: config if CONFIG['features.panels.show.config']: - page_panels.append([nyx.config_panel.ConfigPanel(stdscr, nyx.config_panel.State.TOR)]) + page_panels.append([nyx.config_panel.ConfigPanel(stdscr)]) # fourth page: torrc

1 0

[nyx/master] Simple refactoring
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit d204908cf9e6d81fc768afff9eb1822f1120e5c3 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Sep 25 14:44:42 2015 -0700 Simple refactoring Just a few quick non-functional tweaks. Dropping the is_alive() check is fine since the called function is a no-op when it isn't. --- nyx/config_panel.py | 107 +++++++++++++++++++++------------------------------ 1 file changed, 43 insertions(+), 64 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index 3ef4a4e..ed1d1e1 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -11,8 +11,7 @@ import nyx.popups from nyx.util import panel, tor_config, tor_controller, ui_tools -import stem.control - +from stem.control import State from stem.util import conf, enum, str_tools # attributes of a ConfigEntry @@ -60,31 +59,24 @@ class ConfigEntry(): """ def __init__(self, option, type, is_default): - self.fields = {} - self.fields[Field.OPTION] = option - self.fields[Field.TYPE] = type - self.fields[Field.IS_DEFAULT] = is_default - - # Fetches extra infromation from external sources (the nyx config and tor - # man page). These are None if unavailable for this config option. - - summary = tor_config.get_config_summary(option) man_entry = tor_config.get_config_description(option) - if man_entry: - self.fields[Field.MAN_ENTRY] = man_entry.index - self.fields[Field.CATEGORY] = man_entry.category - self.fields[Field.ARG_USAGE] = man_entry.arg_usage - self.fields[Field.DESCRIPTION] = man_entry.description - else: - self.fields[Field.MAN_ENTRY] = 99999 # sorts non-man entries last - self.fields[Field.CATEGORY] = tor_config.Category.UNKNOWN - self.fields[Field.ARG_USAGE] = '' - self.fields[Field.DESCRIPTION] = '' + self.fields = { + Field.OPTION: option, + Field.TYPE: type, + Field.IS_DEFAULT: is_default, + Field.SUMMARY: tor_config.get_config_summary(option), + + Field.MAN_ENTRY: man_entry.index if man_entry else 99999, # sorts non-man entries last + Field.CATEGORY: man_entry.category if man_entry else tor_config.Category.UNKNOWN, + Field.ARG_USAGE: man_entry.arg_usage if man_entry else '', + Field.DESCRIPTION: man_entry.description if man_entry else '', + } # uses the full man page description if a summary is unavailable - self.fields[Field.SUMMARY] = summary if summary is not None else self.fields[Field.DESCRIPTION] + if self.fields[Field.SUMMARY] is None: + self.fields[Field.SUMMARY] = self.fields[Field.DESCRIPTION] # cache of what's displayed for this configuration option @@ -99,10 +91,7 @@ class ConfigEntry(): field - enum for the field to be provided back """ - if field == Field.VALUE: - return self._get_value() - else: - return self.fields[field] + return self._get_value() if field == Field.VALUE else self.fields[field] def get_all(self, fields): """ @@ -191,19 +180,14 @@ class ConfigPanel(panel.Panel): self.show_all = False - # initializes config contents if we're connected - - controller = tor_controller() - controller.add_status_listener(self.reset_listener) - - if controller.is_alive(): - self.reset_listener(None, stem.control.State.INIT, None) + tor_controller().add_status_listener(self.reset_listener) + self._load_config_options() def reset_listener(self, controller, event_type, _): # fetches configuration options if a new instance, otherewise keeps our # current contents - if event_type == stem.control.State.INIT: + if event_type == State.INIT: self._load_config_options() def _load_config_options(self): @@ -214,30 +198,29 @@ class ConfigPanel(panel.Panel): self.conf_contents = [] self.conf_important_contents = [] - controller, config_option_lines = tor_controller(), [] custom_options = tor_config.get_custom_options() - config_option_query = controller.get_info('config/names', None) + config_names = tor_controller().get_info('config/names', None) - if config_option_query: - config_option_lines = config_option_query.strip().split('\n') + if config_names: + config_option_lines = config_names.strip().split('\n') - for line in config_option_lines: - # lines are of the form "<option> <type>[ <documentation>]", like: - # UseEntryGuards Boolean - # documentation is aparently only in older versions (for instance, - # 0.2.1.25) + for line in config_option_lines: + # lines are of the form "<option> <type>[ <documentation>]", like: + # UseEntryGuards Boolean + # documentation is aparently only in older versions (for instance, + # 0.2.1.25) - line_comp = line.strip().split(' ') - conf_option, conf_type = line_comp[0], line_comp[1] + line_comp = line.strip().split(' ') + conf_option, conf_type = line_comp[0], line_comp[1] - # skips private and virtual entries if not configured to show them + # skips private and virtual entries if not configured to show them - if not CONFIG['features.config.state.showPrivateOptions'] and conf_option.startswith('__'): - continue - elif not CONFIG['features.config.state.showVirtualOptions'] and conf_type == 'Virtual': - continue + if not CONFIG['features.config.state.showPrivateOptions'] and conf_option.startswith('__'): + continue + elif not CONFIG['features.config.state.showVirtualOptions'] and conf_type == 'Virtual': + continue - self.conf_contents.append(ConfigEntry(conf_option, conf_type, conf_option not in custom_options)) + self.conf_contents.append(ConfigEntry(conf_option, conf_type, conf_option not in custom_options)) # mirror listing with only the important configuration options @@ -326,11 +309,7 @@ class ConfigPanel(panel.Panel): selection = self.get_selection() config_option = selection.get(Field.OPTION) - if selection.is_unset(): - initial_value = '' - else: - initial_value = selection.get(Field.VALUE) - + initial_value = '' if selection.is_unset() else selection.get(Field.VALUE) prompt_msg = '%s Value (esc to cancel): ' % config_option is_prepopulated = CONFIG['features.config.prepopulateEditValues'] new_value = nyx.popups.input_prompt(prompt_msg, initial_value if is_prepopulated else '') @@ -462,9 +441,9 @@ class ConfigPanel(panel.Panel): break selection_format = curses.A_STANDOUT if i == selection else curses.A_NORMAL - popup.addstr(height - 2, draw_x, '[') - popup.addstr(height - 2, draw_x + 1, option_label, selection_format, curses.A_BOLD) - popup.addstr(height - 2, draw_x + len(option_label) + 1, ']') + x = popup.addstr(height - 2, draw_x, '[') + x = popup.addstr(height - 2, x, option_label, selection_format, curses.A_BOLD) + popup.addstr(height - 2, x, ']') draw_x -= 1 # space gap between the options @@ -615,11 +594,11 @@ class ConfigPanel(panel.Panel): # Value: <value> ([default|custom], <type>, usage: <argument usage>) if detail_panel_height >= 3: - value_attr = [] - value_attr.append('default' if selection.get(Field.IS_DEFAULT) else 'custom') - value_attr.append(selection.get(Field.TYPE)) - value_attr.append('usage: %s' % (selection.get(Field.ARG_USAGE))) - value_attr_label = ', '.join(value_attr) + value_attr_label = ', '.join([ + 'default' if selection.get(Field.IS_DEFAULT) else 'custom', + selection.get(Field.TYPE), + 'usage: %s' % (selection.get(Field.ARG_USAGE)) + ]) value_label_width = width - 12 - len(value_attr_label) value_label = str_tools.crop(selection.get(Field.VALUE), value_label_width)

1 0

[nyx/master] Drop ConfigEntry's get_all() method
by atagar＠torproject.org 04 Jan '16

04 Jan '16

commit 3a03cf0cbefcf004982e0de270a28b1a4ac3f659 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 26 00:29:33 2015 -0700 Drop ConfigEntry's get_all() method Just an alias for list comprehension, and only used for sorting. --- nyx/config_panel.py | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/nyx/config_panel.py b/nyx/config_panel.py index ed1d1e1..6d80234 100644 --- a/nyx/config_panel.py +++ b/nyx/config_panel.py @@ -93,16 +93,6 @@ class ConfigEntry(): return self._get_value() if field == Field.VALUE else self.fields[field] - def get_all(self, fields): - """ - Provides back a list with the given field values. - - Arguments: - field - enums for the fields to be provided back - """ - - return [self.get(field) for field in fields] - def get_label(self, option_width, value_width, summary_width): """ Provides display string of the configuration entry with the given @@ -269,8 +259,8 @@ class ConfigPanel(panel.Panel): if ordering: CONFIG['features.config.order'] = ordering - self.conf_contents.sort(key=lambda i: (i.get_all(CONFIG['features.config.order']))) - self.conf_important_contents.sort(key=lambda i: (i.get_all(CONFIG['features.config.order']))) + self.conf_contents.sort(key=lambda i: ([i.get(field) for field in CONFIG['features.config.order']])) + self.conf_important_contents.sort(key=lambda i: ([i.get(field) for field in CONFIG['features.config.order']])) def show_sort_dialog(self): """

1 0