- tor-commits - lists.torproject.org

[arm/release] Padding initial setup options
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 5ab244701c1bc56ff57b38371cc62cdbbc6e2bab Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jun 22 08:44:45 2011 -0700 Padding initial setup options Provides a better looking, more centered appearance. --- src/cli/wizard.py | 20 ++++++++++++-------- 1 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 2b7cdf7..f9dd770 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -11,7 +11,7 @@ import cli.controller from util import enum, uiTools # basic configuration types we can run as -RunType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") +RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") # other options provided in the prompts CANCEL, BACK = "Cancel", "Back" @@ -24,16 +24,16 @@ def loadConfig(config): config.update(CONFIG) def showWizard(): - myRole = promptRunType() + myRelayType = promptRelayType() -def promptRunType(): +def promptRelayType(): """ Provides a prompt for selecting the general role we'd like Tor to run with. - This returns a RunType enumeration for the selection, or None if the dialog - was canceled. + This returns a RelayType enumeration for the selection, or None if the + dialog was canceled. """ - popup, _, _ = cli.popups.init(23, 58) + popup, _, _ = cli.popups.init(24, 58) if not popup: return control = cli.controller.getController() key, selection = 0, 0 @@ -41,13 +41,13 @@ def promptRunType(): # constructs (enum, label, [description lines]) tuples for our options options = [] - for runType in RunType.values() + [CANCEL]: + for runType in RelayType.values() + [CANCEL]: label = CONFIG["wizard.role.option.label"].get(runType, "") descRemainder = CONFIG["wizard.role.option.description"].get(runType, "") descLines = [] while descRemainder: - descLine, descRemainder = uiTools.cropStr(descRemainder, 54, None, endType = None, getRemainder = True) + descLine, descRemainder = uiTools.cropStr(descRemainder, 52, None, endType = None, getRemainder = True) descLines.append(descLine.strip()) options.append((runType, label, descLines)) @@ -71,6 +71,10 @@ def promptRunType(): _, label, lines = options[i] optionFormat = format | curses.A_STANDOUT if i == selection else format + # appends an extra space to the start to provide nicer centering + label = " " + label + lines = [" " + line for line in lines] + # Curses has a weird bug where there's a one-pixel alignment # difference between bold and regular text, so it looks better # to render the whitespace here as not being bold.

1 0

[arm/release] fix: getstr y argument wasn't being respected
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 4f8cd4c475d481453471191e435fa514267986a6 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jun 22 18:58:05 2011 -0700 fix: getstr y argument wasn't being respected Never used the row argument before - forgot to respect it in subwindow creation. --- src/util/panel.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/panel.py b/src/util/panel.py index aa3ca27..3f0a98a 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -592,7 +592,7 @@ class Panel(): # temporary subwindow for user input displayWidth = self.getPreferredSize()[1] - inputSubwindow = self.parent.subwin(1, displayWidth - x, self.top, self.left + x) + inputSubwindow = self.parent.subwin(1, displayWidth - x, self.top + y, self.left + x) # prepopulates the initial text if initialText: inputSubwindow.addstr(0, 0, initialText[:displayWidth - x - 1])

1 0

[arm/release] Connect a TorEventObserver instance with LogPanel.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 4ea211ffc54b4c32b9d7cc90e4b395523145484b Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Wed Jun 22 01:15:50 2011 +0500 Connect a TorEventObserver instance with LogPanel. --- src/gui/controller.py | 7 +------ src/gui/logPanel.py | 13 ++++++------- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/src/gui/controller.py b/src/gui/controller.py index c5c8767..090cc31 100644 --- a/src/gui/controller.py +++ b/src/gui/controller.py @@ -24,12 +24,7 @@ class GuiController: self.logPanel = logPanel.LogPanel(self.builder) self.logPanel.pack_widgets() - def random_entries(): - while True: - log.log(log.DEBUG, "Hello World at %s" % time.asctime(time.localtime())) - time.sleep(5) - - thread.start_new_thread(random_entries, ()) + log.log(log.DEBUG, "Hello world!") def run(self): window = self.builder.get_object('window_main') diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index 7197178..78b218a 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -14,7 +14,7 @@ import gtk from TorCtl import TorCtl from util import log, uiTools, torTools -from cli.logPanel import RUNLEVEL_EVENT_COLOR, LogEntry +from cli.logPanel import RUNLEVEL_EVENT_COLOR, LogEntry, TorEventObserver class LogPanel: def __init__(self, builder): @@ -22,12 +22,11 @@ class LogPanel: self.msgLog = deque() - log.LOG_LOCK.acquire() - try: - armRunlevels = [log.DEBUG, log.INFO, log.NOTICE, log.WARN, log.ERR] - log.addListeners(armRunlevels, self._register_arm_event) - finally: - log.LOG_LOCK.release() + armRunlevels = [log.DEBUG, log.INFO, log.NOTICE, log.WARN, log.ERR] + log.addListeners(armRunlevels, self._register_arm_event) + + conn = torTools.getConn() + conn.addEventListener(TorEventObserver(self.register_event)) def fill_log(self): liststore = self.builder.get_object('liststore_log')

1 0

[arm/release] fix: getstr requests can cause curses crash
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 460a76e802bebb57551af5d04bc214f0a6a54a0c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jun 22 18:41:17 2011 -0700 fix: getstr requests can cause curses crash The getstr function creates a curses subwindow which could make a raw addstr request that, if the initial value overflows the subwindow, causes curses to crash. --- src/util/panel.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/panel.py b/src/util/panel.py index 3bdcd6f..aa3ca27 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -595,7 +595,7 @@ class Panel(): inputSubwindow = self.parent.subwin(1, displayWidth - x, self.top, self.left + x) # prepopulates the initial text - if initialText: inputSubwindow.addstr(0, 0, initialText) + if initialText: inputSubwindow.addstr(0, 0, initialText[:displayWidth - x - 1]) # Displays the text field, blocking until the user's done. This closes the # text panel and returns userInput to the initial text if the user presses

1 0

[arm/release] fix: clearing content in a getstr input field
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 6fa3123d8ad9c669db3079d144f7de5117eabd2b Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jun 23 09:03:31 2011 -0700 fix: clearing content in a getstr input field Any stray characters within the textbox is interpreted as part of the initial input. Clearing the input field when we make it and giving an option for limiting its size. --- src/util/panel.py | 12 +++++++++++- 1 files changed, 11 insertions(+), 1 deletions(-) diff --git a/src/util/panel.py b/src/util/panel.py index 5cbeaee..59d2b13 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -573,18 +573,23 @@ class Panel(): baseMsg = "Unclosed formatting tag%s:" % ("s" if len(expectedCloseTags) > 1 else "") raise ValueError("%s: '%s'\n \"%s\"" % (baseMsg, "', '".join(expectedCloseTags), msg)) - def getstr(self, y, x, initialText = "", format = None): + def getstr(self, y, x, initialText = "", format = None, maxWidth = None): """ Provides a text field where the user can input a string, blocking until they've done so and returning the result. If the user presses escape then this terminates and provides back None. This should only be called from the context of a panel's draw method. + This blanks any content within the space that the input field is rendered + (otherwise stray characters would be interpreted as part of the initial + input). + Arguments: y - vertical location x - horizontal location initialText - starting text in this field format - format used for the text + maxWidth - maximum width for the text field """ if not format: format = curses.A_NORMAL @@ -595,8 +600,13 @@ class Panel(): # temporary subwindow for user input displayWidth = self.getPreferredSize()[1] + if maxWidth: displayWidth = min(displayWidth, maxWidth + x) inputSubwindow = self.parent.subwin(1, displayWidth - x, self.top + y, self.left + x) + # blanks the field's area, filling it with the font in case it's hilighting + inputSubwindow.clear() + inputSubwindow.bkgd(' ', format) + # prepopulates the initial text if initialText: inputSubwindow.addstr(0, 0, initialText[:displayWidth - x - 1], format)

1 0

[arm/release] fix: man path for default armrc incorrect
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit adf5b6d8f99d3f68412e64e0d2fe45cf17b4f238 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jun 23 08:22:25 2011 -0700 fix: man path for default armrc incorrect This was changed a while back but didn't get reflected in the man page. Caught by Jérémy Bobbio (http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=631358) --- arm.1 | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/arm.1 b/arm.1 index 6a1fa19..7743035 100644 --- a/arm.1 +++ b/arm.1 @@ -27,7 +27,7 @@ tor control port arm should attach to (default is \fB127.0.0.1:9051\fR) .TP \fB\-c\fR, \fB\-\-config CONFIG_PATH\fR -user provided configuration file (default is \fB~/.armrc\fR) +user provided configuration file (default is \fB~/.arm/armrc\fR) .TP \fB\-d\fR, \fB\-\-debug\fR

1 0

[arm/release] Allow user to sort log entries in preferred order.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit e5ae0d0a95b2739e3e1ec281eeab4f76d779087a Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Jun 21 16:38:18 2011 +0500 Allow user to sort log entries in preferred order. --- src/gui/arm.xml | 18 +++++++++++------- src/gui/controller.py | 11 +++++++++-- src/gui/logPanel.py | 13 +++++++++++-- 3 files changed, 31 insertions(+), 11 deletions(-) diff --git a/src/gui/arm.xml b/src/gui/arm.xml index f067542..1e3681c 100644 --- a/src/gui/arm.xml +++ b/src/gui/arm.xml @@ -136,6 +136,8 @@ </object> <object class="GtkListStore" id="liststore_log"> <columns> +  + <column type="gulong"/>  <column type="gchararray"/>  @@ -691,11 +693,14 @@ each direction. (Default: 0) </span></property> <child> <object class="GtkTreeViewColumn" id="treeviewcolumn_log_timestamp"> <property name="title">Time</property> + <property name="sort_indicator">True</property> + <property name="sort_order">descending</property> + <property name="sort_column_id">1</property> <child> <object class="GtkCellRendererText" id="cellrenderertext_log_timestamp"/> <attributes> - <attribute name="foreground">3</attribute> - <attribute name="markup">0</attribute> + <attribute name="foreground">4</attribute> + <attribute name="markup">1</attribute> </attributes> </child> </object> @@ -706,8 +711,8 @@ each direction. (Default: 0) </span></property> <child> <object class="GtkCellRendererText" id="cellrenderertext_log_type"/> <attributes> - <attribute name="foreground">3</attribute> - <attribute name="markup">1</attribute> + <attribute name="foreground">4</attribute> + <attribute name="markup">2</attribute> </attributes> </child> </object> @@ -718,8 +723,8 @@ each direction. (Default: 0) </span></property> <child> <object class="GtkCellRendererText" id="cellrenderertext_log_msg"/> <attributes> - <attribute name="foreground">3</attribute> - <attribute name="markup">2</attribute> + <attribute name="foreground">4</attribute> + <attribute name="markup">3</attribute> </attributes> </child> </object> @@ -740,5 +745,4 @@ each direction. (Default: 0) </span></property> </object> </child> </object> - <object class="GtkTextBuffer" id="textbuffer_log"/> </interface> diff --git a/src/gui/controller.py b/src/gui/controller.py index 8f27df4..c5c8767 100644 --- a/src/gui/controller.py +++ b/src/gui/controller.py @@ -1,6 +1,9 @@ import gobject import gtk +import thread +import time + from util import log, torTools from gui import logPanel from gui.graphing import bandwidthStats @@ -21,8 +24,12 @@ class GuiController: self.logPanel = logPanel.LogPanel(self.builder) self.logPanel.pack_widgets() - log.log(log.DEBUG, "Hello World!") - log.log(log.ERR, "Hello Again!") + def random_entries(): + while True: + log.log(log.DEBUG, "Hello World at %s" % time.asctime(time.localtime())) + time.sleep(5) + + thread.start_new_thread(random_entries, ()) def run(self): window = self.builder.get_object('window_main') diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index bacc6f2..7197178 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -35,7 +35,7 @@ class LogPanel: for entry in self.msgLog: timeLabel = time.strftime('%H:%M:%S', time.localtime(entry.timestamp)) - row = (timeLabel, entry.type, entry.msg, entry.color) + row = (long(entry.timestamp), timeLabel, entry.type, entry.msg, entry.color) liststore.append(row) def register_event(self, event): @@ -43,7 +43,16 @@ class LogPanel: self.fill_log() def pack_widgets(self): - pass + liststore = self.builder.get_object('liststore_log') + + liststore.set_sort_func(1, self._compare_rows) + liststore.set_sort_column_id(1, gtk.SORT_DESCENDING) + + def _compare_rows(self, treemodel, iter1, iter2, data=None): + timestamp_raw1 = treemodel.get(iter1, 0) + timestamp_raw2 = treemodel.get(iter2, 0) + + return cmp(timestamp_raw1, timestamp_raw2) def _register_arm_event(self, level, msg, eventTime): eventColor = RUNLEVEL_EVENT_COLOR[level]

1 0

[arm/release] Format option for getstr method
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 9ffda70c2203630b41a9f799e754f7f55e70e9b9 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jun 23 08:51:20 2011 -0700 Format option for getstr method Allowing string input fetching to have text attributes. --- src/util/panel.py | 10 ++++++++-- 1 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/util/panel.py b/src/util/panel.py index 3f0a98a..5cbeaee 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -573,7 +573,7 @@ class Panel(): baseMsg = "Unclosed formatting tag%s:" % ("s" if len(expectedCloseTags) > 1 else "") raise ValueError("%s: '%s'\n \"%s\"" % (baseMsg, "', '".join(expectedCloseTags), msg)) - def getstr(self, y, x, initialText = ""): + def getstr(self, y, x, initialText = "", format = None): """ Provides a text field where the user can input a string, blocking until they've done so and returning the result. If the user presses escape then @@ -584,8 +584,11 @@ class Panel(): y - vertical location x - horizontal location initialText - starting text in this field + format - format used for the text """ + if not format: format = curses.A_NORMAL + # makes cursor visible try: previousCursorState = curses.curs_set(1) except curses.error: previousCursorState = 0 @@ -595,7 +598,8 @@ class Panel(): inputSubwindow = self.parent.subwin(1, displayWidth - x, self.top + y, self.left + x) # prepopulates the initial text - if initialText: inputSubwindow.addstr(0, 0, initialText[:displayWidth - x - 1]) + if initialText: + inputSubwindow.addstr(0, 0, initialText[:displayWidth - x - 1], format) # Displays the text field, blocking until the user's done. This closes the # text panel and returns userInput to the initial text if the user presses @@ -609,7 +613,9 @@ class Panel(): else: textbox = curses.textpad.Textbox(inputSubwindow) + textbox.win.attron(format) userInput = textbox.edit(lambda key: _textboxValidate(textbox, key)).strip() + textbox.win.attroff(format) if textbox.lastcmd == curses.ascii.BEL: userInput = None # reverts visability settings

1 0

[arm/release] Migrate CLI code for fetching backlogs as well as TorCtl events.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 7b6d513582ab48619c3ee27bd1baabbfb9b9e9f8 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sat Jun 25 14:58:34 2011 +0500 Migrate CLI code for fetching backlogs as well as TorCtl events. --- src/gui/logPanel.py | 56 ++++++++++++++++++++++++++++++++++++++++++-------- 1 files changed, 47 insertions(+), 9 deletions(-) diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index 78b218a..ab8eb4d 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -14,19 +14,59 @@ import gtk from TorCtl import TorCtl from util import log, uiTools, torTools -from cli.logPanel import RUNLEVEL_EVENT_COLOR, LogEntry, TorEventObserver +from cli.logPanel import (expandEvents, setEventListening, getLogFileEntries, + LogEntry, TorEventObserver, + DEFAULT_CONFIG, RUNLEVEL_EVENT_COLOR) + +STARTUP_EVENTS = 'N3' class LogPanel: def __init__(self, builder): self.builder = builder + self._config = dict(DEFAULT_CONFIG) self.msgLog = deque() + self.loggedEvents = setEventListening(expandEvents(STARTUP_EVENTS)) + + torEventBacklog = deque() + if self._config["features.log.prepopulate"]: + setRunlevels = list(set.intersection(set(self.loggedEvents), set(log.Runlevel.values()))) + readLimit = self._config["features.log.prepopulateReadLimit"] + addLimit = self._config["cache.logPanel.size"] + torEventBacklog = deque(getLogFileEntries(setRunlevels, readLimit, addLimit, self._config)) armRunlevels = [log.DEBUG, log.INFO, log.NOTICE, log.WARN, log.ERR] log.addListeners(armRunlevels, self._register_arm_event) + setRunlevels = [] + for i in range(len(armRunlevels)): + if "ARM_" + log.Runlevel.values()[i] in self.loggedEvents: + setRunlevels.append(armRunlevels[i]) + + armEventBacklog = deque() + for level, msg, eventTime in log._getEntries(setRunlevels): + armEventEntry = LogEntry(eventTime, "ARM_" + level, msg, RUNLEVEL_EVENT_COLOR[level]) + armEventBacklog.appendleft(armEventEntry) + + while armEventBacklog or torEventBacklog: + if not armEventBacklog: + self.msgLog.append(torEventBacklog.popleft()) + elif not torEventBacklog: + self.msgLog.append(armEventBacklog.popleft()) + elif armEventBacklog[0].timestamp < torEventBacklog[0].timestamp: + self.msgLog.append(torEventBacklog.popleft()) + else: + self.msgLog.append(armEventBacklog.popleft()) + conn = torTools.getConn() conn.addEventListener(TorEventObserver(self.register_event)) + conn.addTorCtlListener(self._register_torctl_event) + + def pack_widgets(self): + liststore = self.builder.get_object('liststore_log') + + liststore.set_sort_func(1, self._compare_rows) + liststore.set_sort_column_id(1, gtk.SORT_DESCENDING) def fill_log(self): liststore = self.builder.get_object('liststore_log') @@ -41,11 +81,13 @@ class LogPanel: self.msgLog.appendleft(event) self.fill_log() - def pack_widgets(self): - liststore = self.builder.get_object('liststore_log') + def _register_arm_event(self, level, msg, eventTime): + eventColor = RUNLEVEL_EVENT_COLOR[level] + self.register_event(LogEntry(eventTime, "ARM_%s" % level, msg, eventColor)) - liststore.set_sort_func(1, self._compare_rows) - liststore.set_sort_column_id(1, gtk.SORT_DESCENDING) + def _register_torctl_event(self, level, msg): + eventColor = RUNLEVEL_EVENT_COLOR[level] + self.register_event(LogEntry(time.time(), "TORCTL_%s" % level, msg, eventColor)) def _compare_rows(self, treemodel, iter1, iter2, data=None): timestamp_raw1 = treemodel.get(iter1, 0) @@ -53,7 +95,3 @@ class LogPanel: return cmp(timestamp_raw1, timestamp_raw2) - def _register_arm_event(self, level, msg, eventTime): - eventColor = RUNLEVEL_EVENT_COLOR[level] - self.register_event(LogEntry(eventTime, "ARM_%s" % level, msg, eventColor)) -

1 0

[arm/release] Relay options page for the setup wizard
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 2449cb349a24ab23872f415d0f192b25996f8588 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jun 24 20:05:25 2011 -0700 Relay options page for the setup wizard This has the display and navigation logic for the relay settings page of the wizard. The only bit missing is input validation of the text field inputs (for instance, checking that a bandwidth value will be recognized), but otherwise this part of the wizard is pretty much done. --- src/cli/wizard.py | 242 ++++++++++++++++++++++++++++++++++++++++++++--------- src/settings.cfg | 47 ++++++++--- 2 files changed, 237 insertions(+), 52 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index f9dd770..a3404b9 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -1,6 +1,6 @@ """ Provides user prompts for setting up a new relay. This autogenerates a torrc -that's used by arm to start its tor instance. +that's used by arm to run its own tor instance. """ import curses @@ -13,23 +13,124 @@ from util import enum, uiTools # basic configuration types we can run as RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") +# all options that can be configured +Options = enum.Enum("NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP") +RelayOptions = (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, Options.LIMIT, Options.STARTUP) + # other options provided in the prompts -CANCEL, BACK = "Cancel", "Back" +CANCEL, NEXT, BACK = "Cancel", "Next", "Back" + +MSG_COLOR = "green" +OPTION_COLOR = "yellow" -CONFIG = {"wizard.role.message": "", - "wizard.role.option.label": {}, - "wizard.role.option.description": {}} +CONFIG = {"wizard.message.role": "", + "wizard.message.relay": "", + "wizard.toggle": {}, + "wizard.default": {}, + "wizard.label.general": {}, + "wizard.label.role": {}, + "wizard.label.opt": {}, + "wizard.description.general": {}, + "wizard.description.role": {}, + "wizard.description.opt": {}} def loadConfig(config): config.update(CONFIG) +class ConfigOption: + """ + Attributes of a configuraition option. + """ + + def __init__(self, key, group, default): + """ + Configuration option constructor. + + Arguments: + key - configuration option identifier used when querying attributes + group - configuration attribute group this belongs to + default - initial value, uses the config default if unset + """ + + self.key = key + self.group = group + self.descriptionCache = None + self.descriptionCacheArg = None + self.value = default + + def getKey(self): + return self.key + + def getValue(self): + return self.value + + def getDisplayValue(self): + return self.value + + def setValue(self, value): + self.value = value + + def getLabel(self, prefix = ""): + return prefix + CONFIG["wizard.label.%s" % self.group].get(self.key, "") + + def getDescription(self, width, prefix = ""): + if not self.descriptionCache or self.descriptionCacheArg != width: + optDescription = CONFIG["wizard.description.%s" % self.group].get(self.key, "") + self.descriptionCache = _splitStr(optDescription, width) + self.descriptionCacheArg = width + + return [prefix + line for line in self.descriptionCache] + +class ToggleConfigOption(ConfigOption): + def __init__(self, key, group, default, trueLabel, falseLabel): + ConfigOption.__init__(self, key, group, default) + self.trueLabel = trueLabel + self.falseLabel = falseLabel + + def getDisplayValue(self): + return self.trueLabel if self.value else self.falseLabel + + def toggle(self): + self.value = not self.value + def showWizard(): - myRelayType = promptRelayType() + relayType, config = None, {} + + for option in Options.values(): + toggleValues = CONFIG["wizard.toggle"].get(option) + default = CONFIG["wizard.default"].get(option, "") + + if toggleValues: + if "," in toggleValues: + trueLabel, falseLabel = toggleValues.split(",", 1) + else: trueLabel, falseLabel = toggleValues, "" + + isSet = default.lower() == "true" + config[option] = ToggleConfigOption(option, "opt", isSet, trueLabel.strip(), falseLabel.strip()) + else: config[option] = ConfigOption(option, "opt", default) + + while True: + if relayType == None: + selection = promptRelayType() + + if selection == CANCEL: break + else: relayType = selection + else: + if relayType == RelayType.RELAY: + selection = promptRelayOptions(config) + + if selection == BACK: relayType = None + elif selection == NEXT: break # TODO: implement next screen + else: + break # TODO: other catagories not yet implemented + + # redraws screen to clear away the dialog we just showed + cli.controller.getController().requestRedraw(True) def promptRelayType(): """ Provides a prompt for selecting the general role we'd like Tor to run with. - This returns a RelayType enumeration for the selection, or None if the + This returns a RelayType enumeration for the selection, or CANCEL if the dialog was canceled. """ @@ -37,66 +138,127 @@ def promptRelayType(): if not popup: return control = cli.controller.getController() key, selection = 0, 0 - - # constructs (enum, label, [description lines]) tuples for our options - options = [] - - for runType in RelayType.values() + [CANCEL]: - label = CONFIG["wizard.role.option.label"].get(runType, "") - descRemainder = CONFIG["wizard.role.option.description"].get(runType, "") - descLines = [] - - while descRemainder: - descLine, descRemainder = uiTools.cropStr(descRemainder, 52, None, endType = None, getRemainder = True) - descLines.append(descLine.strip()) - - options.append((runType, label, descLines)) + options = [ConfigOption(opt, "role", opt) for opt in RelayType.values()] + options.append(ConfigOption(CANCEL, "general", CANCEL)) try: popup.win.box() curses.cbreak() - format = uiTools.getColor("green") - y, msgRemainder = 1, CONFIG["wizard.role.message"] # provides the welcoming message - while msgRemainder: - msg, msgRemainder = uiTools.cropStr(msgRemainder, 54, None, endType = None, getRemainder = True) - popup.addstr(y, 2, msg.strip(), format | curses.A_BOLD) - y += 1 + topContent = _splitStr(CONFIG["wizard.message.role"], 54) + for i in range(len(topContent)): + popup.addstr(i + 1, 2, topContent[i], curses.A_BOLD | uiTools.getColor(MSG_COLOR)) - while not uiTools.isSelectionKey(key): - offset = 0 + while True: + y, offset = len(topContent) + 1, 0 for i in range(len(options)): - _, label, lines = options[i] - optionFormat = format | curses.A_STANDOUT if i == selection else format - - # appends an extra space to the start to provide nicer centering - label = " " + label - lines = [" " + line for line in lines] + optionFormat = uiTools.getColor(MSG_COLOR) + if i == selection: optionFormat |= curses.A_STANDOUT # Curses has a weird bug where there's a one-pixel alignment # difference between bold and regular text, so it looks better # to render the whitespace here as not being bold. offset += 1 + label = options[i].getLabel(" ") popup.addstr(y + offset, 2, label, optionFormat | curses.A_BOLD) popup.addstr(y + offset, 2 + len(label), " " * (54 - len(label)), optionFormat) offset += 1 - for line in lines: + for line in options[i].getDescription(52, " "): popup.addstr(y + offset, 2, uiTools.padStr(line, 54), optionFormat) offset += 1 popup.win.refresh() key = control.getScreen().getch() - if key == curses.KEY_UP: selection = max(0, selection - 1) - elif key == curses.KEY_DOWN: selection = min(len(options) - 1, selection + 1) + if key == curses.KEY_UP: selection = (selection - 1) % len(options) + elif key == curses.KEY_DOWN: selection = (selection + 1) % len(options) + elif uiTools.isSelectionKey(key): return options[selection].getValue() + elif key == 27: return CANCEL # esc - cancel + finally: + cli.popups.finalize() + +def promptRelayOptions(config): + """ + Prompts the user for the configuration of an internal relay. + """ + + popup, _, _ = cli.popups.init(23, 58) + if not popup: return + control = cli.controller.getController() + options = [config[opt] for opt in RelayOptions] + options.append(ConfigOption(BACK, "general", "(to role selection)")) + options.append(ConfigOption(NEXT, "general", "(to confirm options)")) + key, selection = 0, 0 + + try: + curses.cbreak() + + while True: + popup.win.erase() + popup.win.box() + + # provides the description for internal relays + topContent = _splitStr(CONFIG["wizard.message.relay"], 54) + for i in range(len(topContent)): + popup.addstr(i + 1, 2, topContent[i], curses.A_BOLD | uiTools.getColor(MSG_COLOR)) + + y, offset = len(topContent) + 1, 0 + for i in range(len(options)): + label = " %-30s%s" % (options[i].getLabel(), options[i].getDisplayValue()) + optionFormat = curses.A_BOLD | uiTools.getColor(OPTION_COLOR) + if i == selection: optionFormat |= curses.A_STANDOUT + + offset += 1 + popup.addstr(y + offset, 2, uiTools.padStr(label, 54), optionFormat) + + # extra space to divide options/navigation + if i == len(options) - 3: offset += 1 + + # divider between the options and description + offset += 2 + popup.addch(y + offset, 0, curses.ACS_LTEE) + popup.addch(y + offset, popup.getWidth() - 1, curses.ACS_RTEE) + popup.hline(y + offset, 1, popup.getWidth() - 2) + + # description for the currently selected option + for line in options[selection].getDescription(54, " "): + offset += 1 + popup.addstr(y + offset, 1, line, uiTools.getColor(MSG_COLOR)) + + popup.win.refresh() + key = control.getScreen().getch() + + if key == curses.KEY_UP: selection = (selection - 1) % len(options) + elif key == curses.KEY_DOWN: selection = (selection + 1) % len(options) + elif uiTools.isSelectionKey(key): + if selection == len(options) - 2: return BACK # selected back + elif selection == len(options) - 1: return NEXT # selected next + elif isinstance(options[selection], ToggleConfigOption): + options[selection].toggle() + else: + newValue = popup.getstr(y + selection + 1, 33, options[selection].getValue(), curses.A_STANDOUT | uiTools.getColor(OPTION_COLOR), 23) + if newValue: options[selection].setValue(newValue.strip()) elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel finally: cli.popups.finalize() + +def _splitStr(msg, width): + """ + Splits a string into substrings of a given length. + + Arguments: + msg - string to be broken up + width - max length of any returned substring + """ + + results = [] + while msg: + msgSegment, msg = uiTools.cropStr(msg, width, None, endType = None, getRemainder = True) + results.append(msgSegment.strip()) - selectedOption = options[selection][0] - return None if selectedOption == CANCEL else selectedOption + return results diff --git a/src/settings.cfg b/src/settings.cfg index 2ad2784..94ff9c1 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -340,20 +340,43 @@ msg.ARM_DEBUG GETINFO traffic/written msg.ARM_DEBUG GETCONF msg.ARM_DEBUG Unable to query process resource usage from ps -# descriptions used in the relay setup wizard -wizard.role.message Welcome to the Tor network! This will step you through the configuration process for being a part of it. To start with, what role would you like to have? +# configuration option attributes used in the relay setup wizard +wizard.message.role Welcome to the Tor network! This will step you through the configuration process for becoming a part of it. To start with, what role would you like to have? +wizard.message.relay Internal relays provide connections within the Tor network. Since you will only be connecting to Tor users and relays this is an easy, hassle free way of helping to make the network better. -wizard.role.option.label Relay => Internal Relay -wizard.role.option.label Exit => Exit Relay -wizard.role.option.label Bridge => Bridge -wizard.role.option.label Client => Client -wizard.role.option.label Cancel => Cancel +wizard.toggle Notify => Yes, No +wizard.toggle Startup => Yes, No -wizard.role.option.description Relay => Provides interconnections with other Tor relays. This is a safe and easy of making the network better. -wizard.role.option.description Exit => Connects between Tor an the outside Internet. This is a vital role, but can lead to abuse complaints. -wizard.role.option.description Bridge => Non-public relay specifically for helping censored users. -wizard.role.option.description Client => Use the network without contributing to it. -wizard.role.option.description Cancel => Close without starting Tor. +wizard.default Nickname => Unnamed +wizard.default Notify => true +wizard.default Bandwidth => 5 MB/s +wizard.default Startup => true + +wizard.label.general Cancel => Cancel +wizard.label.general Back => Previous +wizard.label.general Next => Next +wizard.label.role Relay => Internal Relay +wizard.label.role Exit => Exit Relay +wizard.label.role Bridge => Bridge +wizard.label.role Client => Client +wizard.label.opt Nickname => Nickname +wizard.label.opt Contact => Contact Information +wizard.label.opt Notify => Issue Notification +wizard.label.opt Bandwidth => Relay Speed +wizard.label.opt Limit => Monthly Limit +wizard.label.opt Startup => Run At Startup + +wizard.description.general Cancel => Close without starting Tor. +wizard.description.role Relay => Provides interconnections with other Tor relays. This is a safe and easy of making the network better. +wizard.description.role Exit => Connects between Tor an the outside Internet. This is a vital role, but can lead to abuse complaints. +wizard.description.role Bridge => Non-public relay specifically for helping censored users. +wizard.description.role Client => Use the network without contributing to it. +wizard.description.opt Nickname => Human friendly name for your relay. If this is unique then it's used instead of your fingerprint (a forty character hex string) when pages like TorStatus refer to you. +wizard.description.opt Contact => Address we can contact you at if there's a problem with your relay. This is public information so, if it looks like an email address, we'll obscure it a bit. +wizard.description.opt Notify => Sends automated email notifications to the above address if your relay is unreachable or out of date. This service is provided by Tor Weather (https://weather.torproject.org/) and will send you a confirmation email before it's started. +wizard.description.opt Bandwidth => Limit for the average rate at which you relay traffic. +wizard.description.opt Limit => Maximum amount of traffic to relay each month. Some ISPs, like Comcast, cap their customer's Internet usage so this is an easy way of staying below that limit. +wizard.description.opt Startup => Runs Tor in the background when the system starts. # some config options are fetched via special values torrc.map HiddenServiceDir => HiddenServiceOptions

1 0