- tor-commits - lists.torproject.org

[arm/release] Moving torrc validation logging to the torConfig
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit ed7b9ec4f7d4ccc3e4a417f416b519b9a9865a11 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 19:21:52 2011 -0700 Moving torrc validation logging to the torConfig --- src/cli/controller.py | 72 +++--------------------------------------------- src/util/torConfig.py | 69 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 73 insertions(+), 68 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index d44b811..5696daa 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -103,9 +103,7 @@ CONFIG = {"features.graph.type": 1, "log.startTime": log.INFO, "log.refreshRate": log.DEBUG, "log.highCpuUsage": log.WARN, - "log.configEntryUndefined": log.NOTICE, - "log.torrc.validation.torStateDiffers": log.WARN, - "log.torrc.validation.unnecessaryTorrcEntries": log.NOTICE} + "log.configEntryUndefined": log.NOTICE} class ControlPanel(panel.Panel): """ Draws single line label for interface controls. """ @@ -282,72 +280,12 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # confLocation = "" # loads the torrc and provides warnings in case of validation errors - loadedTorrc = torConfig.getTorrc() - loadedTorrc.getLock().acquire() - - try: loadedTorrc.load(True) + try: + loadedTorrc = torConfig.getTorrc() + loadedTorrc.load(True) + loadedTorrc.logValidationIssues() except: pass - if loadedTorrc.isLoaded(): - corrections = loadedTorrc.getCorrections() - duplicateOptions, defaultOptions, mismatchLines, missingOptions = [], [], [], [] - - for lineNum, issue, msg in corrections: - if issue == torConfig.ValidationError.DUPLICATE: - duplicateOptions.append("%s (line %i)" % (msg, lineNum + 1)) - elif issue == torConfig.ValidationError.IS_DEFAULT: - defaultOptions.append("%s (line %i)" % (msg, lineNum + 1)) - elif issue == torConfig.ValidationError.MISMATCH: mismatchLines.append(lineNum + 1) - elif issue == torConfig.ValidationError.MISSING: missingOptions.append(msg) - - if duplicateOptions or defaultOptions: - msg = "Unneeded torrc entries found. They've been highlighted in blue on the torrc page." - - if duplicateOptions: - if len(duplicateOptions) > 1: - msg += "\n- entries ignored due to having duplicates: " - else: - msg += "\n- entry ignored due to having a duplicate: " - - duplicateOptions.sort() - msg += ", ".join(duplicateOptions) - - if defaultOptions: - if len(defaultOptions) > 1: - msg += "\n- entries match their default values: " - else: - msg += "\n- entry matches its default value: " - - defaultOptions.sort() - msg += ", ".join(defaultOptions) - - log.log(CONFIG["log.torrc.validation.unnecessaryTorrcEntries"], msg) - - if mismatchLines or missingOptions: - msg = "The torrc differ from what tor's using. You can issue a sighup to reload the torrc values by pressing x." - - if mismatchLines: - if len(mismatchLines) > 1: - msg += "\n- torrc values differ on lines: " - else: - msg += "\n- torrc value differs on line: " - - mismatchLines.sort() - msg += ", ".join([str(val + 1) for val in mismatchLines]) - - if missingOptions: - if len(missingOptions) > 1: - msg += "\n- configuration values are missing from the torrc: " - else: - msg += "\n- configuration value is missing from the torrc: " - - missingOptions.sort() - msg += ", ".join(missingOptions) - - log.log(CONFIG["log.torrc.validation.torStateDiffers"], msg) - - loadedTorrc.getLock().release() - # minor refinements for connection resolver if not isBlindMode: if torPid: diff --git a/src/util/torConfig.py b/src/util/torConfig.py index a083099..14ef4ce 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -23,7 +23,9 @@ CONFIG = {"features.torrc.validate": True, "torrc.label.time.day": [], "torrc.label.time.week": [], "log.torrc.readFailed": log.WARN, - "log.configDescriptions.unrecognizedCategory": log.NOTICE} + "log.configDescriptions.unrecognizedCategory": log.NOTICE, + "log.torrc.validation.unnecessaryTorrcEntries": log.NOTICE, + "log.torrc.validation.torStateDiffers": log.WARN} # enums and values for numeric torrc entries ValueType = enum.Enum("UNRECOGNIZED", "SIZE", "TIME") @@ -753,6 +755,71 @@ class Torrc(): """ return self.valsLock + + def logValidationIssues(self): + """ + Performs validation on the loaded contents, and logs warnings for issues + that are found. + """ + + corrections = self.getCorrections() + + if corrections: + duplicateOptions, defaultOptions, mismatchLines, missingOptions = [], [], [], [] + + for lineNum, issue, msg in corrections: + if issue == ValidationError.DUPLICATE: + duplicateOptions.append("%s (line %i)" % (msg, lineNum + 1)) + elif issue == ValidationError.IS_DEFAULT: + defaultOptions.append("%s (line %i)" % (msg, lineNum + 1)) + elif issue == ValidationError.MISMATCH: mismatchLines.append(lineNum + 1) + elif issue == ValidationError.MISSING: missingOptions.append(msg) + + if duplicateOptions or defaultOptions: + msg = "Unneeded torrc entries found. They've been highlighted in blue on the torrc page." + + if duplicateOptions: + if len(duplicateOptions) > 1: + msg += "\n- entries ignored due to having duplicates: " + else: + msg += "\n- entry ignored due to having a duplicate: " + + duplicateOptions.sort() + msg += ", ".join(duplicateOptions) + + if defaultOptions: + if len(defaultOptions) > 1: + msg += "\n- entries match their default values: " + else: + msg += "\n- entry matches its default value: " + + defaultOptions.sort() + msg += ", ".join(defaultOptions) + + log.log(CONFIG["log.torrc.validation.unnecessaryTorrcEntries"], msg) + + if mismatchLines or missingOptions: + msg = "The torrc differ from what tor's using. You can issue a sighup to reload the torrc values by pressing x." + + if mismatchLines: + if len(mismatchLines) > 1: + msg += "\n- torrc values differ on lines: " + else: + msg += "\n- torrc value differs on line: " + + mismatchLines.sort() + msg += ", ".join([str(val + 1) for val in mismatchLines]) + + if missingOptions: + if len(missingOptions) > 1: + msg += "\n- configuration values are missing from the torrc: " + else: + msg += "\n- configuration value is missing from the torrc: " + + missingOptions.sort() + msg += ", ".join(missingOptions) + + log.log(CONFIG["log.torrc.validation.torStateDiffers"], msg) def _testConfigDescriptions(): """

1 0

[arm/release] Dropping the old sighup tracker
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 2df780f6d3a8c676b670db7542930d88e942b595 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 19:44:18 2011 -0700 Dropping the old sighup tracker This functionality has been replaced by connection state listeners, and the last users of this hack have been refactored. --- src/cli/controller.py | 31 ------------------------------- 1 files changed, 0 insertions(+), 31 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 63f62e5..030b1d3 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -179,20 +179,6 @@ class ControlPanel(panel.Panel): self.addstr(0, xLoc + 1, " " * barProgress, curses.A_STANDOUT | uiTools.getColor("red")) self.addstr(0, xLoc + barWidth + 1, "]", curses.A_BOLD) -class sighupListener(TorCtl.PostEventListener): - """ - Listens for reload signal (hup), which is produced by: - pkill -sighup tor - causing the torrc and internal state to be reset. - """ - - def __init__(self): - TorCtl.PostEventListener.__init__(self) - self.isReset = False - - def msg_event(self, event): - self.isReset |= event.level == "NOTICE" and event.msg.startswith("Received reload signal (hup)") - def setPauseState(panels, monitorIsPaused, currentPage, overwrite=False): """ Resets the isPaused state of panels. If overwrite is True then this pauses @@ -332,12 +318,10 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): elif graphType == 3: panels["graph"].setStats("system resources") # listeners that update bandwidth and log panels with Tor status - sighupTracker = sighupListener() #conn.add_event_listener(panels["log"]) conn.add_event_listener(panels["graph"].stats["bandwidth"]) conn.add_event_listener(panels["graph"].stats["system resources"]) if not isBlindMode: conn.add_event_listener(panels["graph"].stats["connections"]) - conn.add_event_listener(sighupTracker) # prepopulates bandwidth values from state file if CONFIG["features.graph.bw.prepopulate"]: @@ -420,21 +404,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): try: redrawStartTime = time.time() - # if sighup received then reload related information - if sighupTracker.isReset: - #panels["header"]._updateParams(True) - - # other panels that use torrc data - #if not isBlindMode: panels["graph"].stats["connections"].resetOptions(conn) - #panels["graph"].stats["bandwidth"].resetOptions() - - # if bandwidth graph is being shown then height might have changed - if panels["graph"].currentDisplay == "bandwidth": - panels["graph"].setHeight(panels["graph"].stats["bandwidth"].getContentHeight()) - - - sighupTracker.isReset = False - # gives panels a chance to take advantage of the maximum bounds # originally this checked in the bounds changed but 'recreate' is a no-op # if panel properties are unchanged and checking every redraw is more

1 0

[arm/release] Adding the quiet flag to torctl fetches
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 8a6099a62642b919a90e21fff0638ba30ab8f552 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 14 13:04:49 2011 -0700 Adding the quiet flag to torctl fetches I was suppressing 'git clone' stdout on my local system but this wasn't working on others. Adding the --quiet flag which is a better solution anyway. --- src/prereq.py | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/prereq.py b/src/prereq.py index 50aaa91..4bda913 100644 --- a/src/prereq.py +++ b/src/prereq.py @@ -23,7 +23,7 @@ def isTorCtlAvailable(): def promptTorCtlInstall(): """ Asks the user to install TorCtl. This returns True if it was installed and - False otherwise (if it was either declined or failed to be fetched. + False otherwise (if it was either declined or failed to be fetched). """ userInput = raw_input("Arm requires TorCtl to run, but it's unavailable. Would you like to install it? (y/n): ") @@ -57,7 +57,7 @@ def installTorCtl(): tmpFilename = tempfile.mktemp("/torctl") # fetches TorCtl - exitStatus = os.system("git clone %s %s > /dev/null" % (TORCTL_REPO, tmpFilename)) + exitStatus = os.system("git clone --quiet %s %s > /dev/null" % (TORCTL_REPO, tmpFilename)) if exitStatus: raise IOError("Unable to get TorCtl from %s. Is git installed?" % TORCTL_REPO) # the destination for TorCtl will be our directory

1 0

[arm/release] fix: Removing case sensetivity from stat names
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 624f13d79870fbbc1e47f17d97d105a24d12d54e Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 19 09:57:18 2011 -0700 fix: Removing case sensetivity from stat names When making a graphed stat selection arm would crash if the string used for the stat key contained capital letters. This wasn't a problem since the controller used lowercase keys, but there's no reason to need this assumption. --- src/cli/graphing/graphPanel.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py index ae8e73c..615118a 100644 --- a/src/cli/graphing/graphPanel.py +++ b/src/cli/graphing/graphPanel.py @@ -297,7 +297,7 @@ class GraphPanel(panel.Panel): # applies new setting if selection == 0: self.setStats(None) - elif selection != -1: self.setStats(options[selection].lower()) + elif selection != -1: self.setStats(availableStats[selection - 1]) elif key == ord('i') or key == ord('I'): # provides menu to pick graph panel update interval options = [label for (label, _) in UPDATE_INTERVALS]

1 0

[arm/release] Dropping the last raw TorCtl usage
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit c21dbc32601b467968c0a900f0b79c2738b7d1e3 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 14 14:11:56 2011 -0700 Dropping the last raw TorCtl usage This removes the last direct usage of TorCtl by arm. Instead, all access is done via the torTools Connection wrapper class. In addition to being easier and provide better performance, removing this last direct TorCtl usage should allow for arm to be arbitrarily detatched and reattached to Tor instances while running (the option for reattaching is coming soon...). --- src/cli/controller.py | 52 ++++----------------------------------- src/cli/graphing/graphPanel.py | 5 +++- 2 files changed, 10 insertions(+), 47 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 030b1d3..4916faf 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -7,13 +7,9 @@ Curses (terminal) interface for the arm relay status monitor. """ import os -import re import math import time import curses -import curses.textpad -import socket -from TorCtl import TorCtl import popups import headerPanel @@ -21,7 +17,6 @@ import graphing.graphPanel import logPanel import configPanel import torrcPanel -import descriptorPopup import cli.connections.connPanel import cli.connections.connEntry @@ -43,6 +38,7 @@ def refresh(): PANELS = {} STDSCR = None IS_PAUSED = False +PAGE = 0 def getScreen(): return STDSCR @@ -214,10 +210,10 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): """ Starts arm interface reflecting information on provided control port. - stdscr - curses window - conn - active Tor control port connection - loggedEvents - types of events to be logged (plus an optional "UNKNOWN" for - otherwise unrecognized events) + stdscr - curses window + startTime - unix time for when arm was started + loggedEvents - event types we've been configured to log + isBlindMode - flag to indicate if the user's turned off connection lookups """ global PANELS, STDSCR, REFRESH_FLAG, PAGE, IS_PAUSED @@ -240,9 +236,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # pauses/unpauses connection resolution according to if tor's connected or not torTools.getConn().addStatusListener(connResetListener) - # TODO: incrementally drop this requirement until everything's using the singleton - conn = torTools.getConn().getTorCtl() - curses.halfdelay(REFRESH_RATE * 10) # uses getch call as timer for REFRESH_RATE seconds try: curses.use_default_colors() # allows things like semi-transparent backgrounds (call can fail with ERR) except curses.error: pass @@ -254,17 +247,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # attempts to determine tor's current pid (left as None if unresolveable, logging an error later) torPid = torTools.getConn().getMyPid() - #try: - # confLocation = conn.get_info("config-file")["config-file"] - # if confLocation[0] != "/": - # # relative path - attempt to add process pwd - # try: - # results = sysTools.call("pwdx %s" % torPid) - # if len(results) == 1 and len(results[0].split()) == 2: confLocation = "%s/%s" % (results[0].split()[1], confLocation) - # except IOError: pass # pwdx call failed - #except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed): - # confLocation = "" - # loads the torrc and provides warnings in case of validation errors try: loadedTorrc = torConfig.getTorrc() @@ -317,12 +299,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): elif graphType == 2 and not isBlindMode: panels["graph"].setStats("connections") elif graphType == 3: panels["graph"].setStats("system resources") - # listeners that update bandwidth and log panels with Tor status - #conn.add_event_listener(panels["log"]) - conn.add_event_listener(panels["graph"].stats["bandwidth"]) - conn.add_event_listener(panels["graph"].stats["system resources"]) - if not isBlindMode: conn.add_event_listener(panels["graph"].stats["connections"]) - # prepopulates bandwidth values from state file if CONFIG["features.graph.bw.prepopulate"]: isSuccessful = panels["graph"].stats["bandwidth"].prepopulateFromState() @@ -332,11 +308,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): #panels["log"].loggedEvents = loggedEvents # strips any that couldn't be set panels["log"].setLoggedEvents(loggedEvents) # strips any that couldn't be set - # directs logged TorCtl events to log panel - #TorUtil.loglevel = "DEBUG" - #TorUtil.logfile = panels["log"] - #torTools.getConn().addTorCtlListener(panels["log"].tor_ctl_event) - # provides a notice about any event types tor supports but arm doesn't missingEventTypes = logPanel.getMissingEventTypes() if missingEventTypes: @@ -350,16 +321,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panels["log"].start() panels["conn"].start() - # warns if tor isn't updating descriptors - #try: - # if conn.get_option("FetchUselessDescriptors")[0][1] == "0" and conn.get_option("DirPort")[0][1] == "0": - # warning = """Descriptors won't be updated (causing some connection information to be stale) unless: - #a. 'FetchUselessDescriptors 1' is set in your torrc - #b. the directory service is provided ('DirPort' defined) - #c. or tor is used as a client""" - # log.log(log.WARN, warning) - #except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed): pass - isUnresponsive = False # true if it's been over ten seconds since the last BW event (probably due to Tor closing) isPaused = False # if true updates are frozen overrideKey = None # immediately runs with this input rather than waiting for the user if set @@ -523,8 +484,7 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panels["conn"].join() panels["log"].join() - conn = torTools.getConn() - conn.close() # joins on TorCtl event thread + torTools.getConn().close() # joins on TorCtl event thread # joins on utility daemon threads - this might take a moment since # the internal threadpools being joined might be sleeping diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py index ef0267d..ae8e73c 100644 --- a/src/cli/graphing/graphPanel.py +++ b/src/cli/graphing/graphPanel.py @@ -22,7 +22,7 @@ from TorCtl import TorCtl import cli.popups -from util import enum, panel, uiTools +from util import enum, panel, torTools, uiTools # time intervals at which graphs can be updated UPDATE_INTERVALS = [("each second", 1), ("5 seconds", 5), ("30 seconds", 30), @@ -92,6 +92,9 @@ class GraphStats(TorCtl.PostEventListener): # iterative insert needed to avoid making shallow copies (nasty, nasty gotcha) self.primaryCounts[i] = (self.maxCol + 1) * [0] self.secondaryCounts[i] = (self.maxCol + 1) * [0] + + # tracks BW events + torTools.getConn().addEventListener(self) def clone(self, newCopy=None): """

1 0

[arm/release] fix: missing import after the text input move
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit a5737a023c9363bfd375614c2f9c067059c7e998 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 18 20:28:35 2011 -0700 fix: missing import after the text input move Pressing enter to prompt for text input caused a crash (odd I didn't catch this earlier...). --- src/util/panel.py | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/src/util/panel.py b/src/util/panel.py index 06c8649..a104a07 100644 --- a/src/util/panel.py +++ b/src/util/panel.py @@ -7,6 +7,7 @@ import copy import time import traceback import curses +import curses.textpad from threading import RLock from util import log, uiTools

1 0

[arm/release] Updating the arm readme FAQ
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 38acbe83903fefcbacc94a3bdfc9bfcc7fe65774 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 14 13:43:04 2011 -0700 Updating the arm readme FAQ Arm no longer provides hostname resolution (for now...) so the caveat on arm sometimes actively querying information is no longer accurate. I dropped the warning about stale descriptors, mostly since it was causing confusion without any benefit. However, this can still cause some confusion if relay operators use that information. Hence I'm adding a description for what consensus/descriptors entries are, with the workaround. --- README | 46 ++++++++++++++++++++++++++++++++++------------ 1 files changed, 34 insertions(+), 12 deletions(-) diff --git a/README b/README index e7c2e2c..456aba1 100644 --- a/README +++ b/README @@ -88,22 +88,13 @@ share and it should be fine. > Is there any chance that arm will leak data? -Not by default, arm is a passive listener with one exception. The second page -(connections) provides the hostnames of Tor relays you're connected to. This -means reverse DNS lookups which, if monitored, could leak your current -connections to an eavesdropper. However, this is disabled by default and -lookups are only made upon request (when showing connection details or listing -connections by hostname). See the page's help for how to enable lookups. - -That said, this is not a terribly big whoop. ISPs and anyone sniffing your -connection already have this data - the only difference is that instead of -saying "I am talking to x" you're saying "I'm talking to x, who's x?", meaning -the resolver's also aware of who they are. +No. Arm is a completely passive listener, fetching all information from either +Tor or the local system. > When arm starts it gives "Unable to resolve tor pid, abandoning connection listing"... why? -If you're running multiple instances of tor then arm needs to figure out which +If you're running multiple instances of Tor then arm needs to figure out which pid belongs to the open control port. If it's running as a different user (such as being in a chroot jail) then it's probably failing due to permission issues. Arm still runs, just no connection listing or ps stats. @@ -114,6 +105,37 @@ Some terminals, most notably screen sessions on Gentoo, appear to have a bug where highlighted spaces aren't rendered. A reported workaround is to set: TERM="rxvt-unicode" +> When I press enter in the connection panel to get details some of the +information is either missing or outdated. Why is this? + +There are two sources of information about Tor relays: their consensus and +descriptor entries. + +The consensus entry is provided on an hourly basis by the Tor directory +authorities (special relays that keep track of all the relays in the network). +The consensus has information like the nickname, flags, and in newer Tor +versions a summarized exit policy. + +The descriptor entry, however, is published by the relays themselves and has +information like their platform, contact information, family, public keys, +exit policy, etc. These are much larger than the consensus entries and don't +change unless the relay changes their configuration. + +Everyone in the Tor network (both relays and users) need the consensus entries +to operate. However, only users (not relays) need the descriptor entries. + +Tor will fetch both the consensus and descriptors for all of the currently +active relays when it first starts. But to save bandwidth only the consensus +entries are updated after this unless... +a. 'FetchUselessDescriptors 1' is set in your torrc +b. the directory service is provided ('DirPort' defined) +c. you use Tor as a client + +This means that some of the information on the connection page (like the +platform and contact information) might be missing or stale due to missing +descriptors. This isn't important to most users, but if you need this +information then this is simple to fix with the above. + ------------------------------------------------------------------------------- Layout:

1 0

[arm/release] fix: Config setter missing list wrapper
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit dc4fd607b78e406cd2fc81beb9e299e2d6aea6a8 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 19 18:33:34 2011 -0700 fix: Config setter missing list wrapper Configuration values are internally stored as lists of values. The setter was missing this detail (this is the first time I'm using it...). --- src/util/conf.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/conf.py b/src/util/conf.py index 66280c9..bfbf468 100644 --- a/src/util/conf.py +++ b/src/util/conf.py @@ -268,7 +268,7 @@ class Config(): """ self.contentsLock.acquire() - self.contents[key] = value + self.contents[key] = [value] self.contentsLock.release() def clear(self):

1 0

[arm/release] Support for rendering unicode characters if able
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit f27c4c97a2abd0d89a235969ecee8ce77148ad9b Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 20 19:52:11 2011 -0700 Support for rendering unicode characters if able Checks for the multi-byte rendering type and curses wide character support, providing a util for checking if unicode rendering will work and enabling it if so. --- armrc.sample | 3 ++ src/cli/controller.py | 8 +++++- src/util/uiTools.py | 71 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 1 deletions(-) diff --git a/armrc.sample b/armrc.sample index 9f75ccc..ecfe45a 100644 --- a/armrc.sample +++ b/armrc.sample @@ -19,6 +19,9 @@ queries.useProc true # Renders the interface with color if set and the terminal supports it features.colorInterface true +# Includes unicode characters in the interface. +features.printUnicode true + # Checks the torrc for issues, warning and hilighting problems if true features.torrc.validate true diff --git a/src/cli/controller.py b/src/cli/controller.py index a1ec58a..8222da8 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -4,6 +4,7 @@ user input to the proper panels. """ import time +import locale import curses import threading @@ -18,7 +19,7 @@ import cli.graphing.connStats import cli.graphing.resourceStats import cli.connections.connPanel -from util import connections, conf, enum, log, panel, sysTools, torConfig, torTools +from util import connections, conf, enum, log, panel, sysTools, torConfig, torTools, uiTools ARM_CONTROLLER = None @@ -459,6 +460,11 @@ def drawTorMonitor(stdscr, startTime): try: curses.curs_set(0) except curses.error: pass + # If using our LANG variable for rendering multi-byte characters lets us + # get unicode support then then use it. + if uiTools.isUnicodeAvailable(): + locale.setlocale(locale.LC_ALL, "") + # logs the initialization time msg = "arm started (initialization took %0.3f seconds)" % (time.time() - startTime) log.log(CONFIG["log.startTime"], msg) diff --git a/src/util/uiTools.py b/src/util/uiTools.py index b3b919a..0ff680e 100644 --- a/src/util/uiTools.py +++ b/src/util/uiTools.py @@ -5,6 +5,7 @@ easy method of providing the following interface components: - unit conversion for labels """ +import os import sys import curses @@ -35,8 +36,13 @@ TIME_UNITS = [(86400.0, "d", " day"), (3600.0, "h", " hour"), Ending = enum.Enum("ELLIPSE", "HYPHEN") SCROLL_KEYS = (curses.KEY_UP, curses.KEY_DOWN, curses.KEY_PPAGE, curses.KEY_NPAGE, curses.KEY_HOME, curses.KEY_END) CONFIG = {"features.colorInterface": True, + "features.printUnicode": True, "log.cursesColorSupport": log.INFO} +# Flag indicating if unicode is supported by curses. If None then this has yet +# to be determined. +IS_UNICODE_SUPPORTED = None + def loadConfig(config): config.update(CONFIG) @@ -87,6 +93,29 @@ def _showGlyphs(stdscr): stdscr.getch() # quit on keyboard input +def isUnicodeAvailable(): + """ + True if curses has wide character support, false otherwise or if it can't be + determined. + """ + + global IS_UNICODE_SUPPORTED + if IS_UNICODE_SUPPORTED == None: + import sysTools + + if CONFIG["features.printUnicode"]: + # Checks if our LANG variable is unicode. This is what will be respected + # when printing multi-byte characters after calling... + # locale.setlocale(locale.LC_ALL, '') + # + # so if the LANG isn't unicode then setting this would be pointless. + + isLangUnicode = "utf-" in os.environ.get("LANG", "").lower() + IS_UNICODE_SUPPORTED = isLangUnicode and _isWideCharactersAvailable() + else: IS_UNICODE_SUPPORTED = False + + return IS_UNICODE_SUPPORTED + def getPrintable(line, keepNewlines = True): """ Provides the line back with non-printable characters stripped. @@ -606,6 +635,48 @@ def _getLabel(units, count, decimal, isLong): return countLabel + longLabel + ("s" if isPlural else "") else: return countLabel + shortLabel +def _isWideCharactersAvailable(): + """ + True if curses has wide character support (which is required to print + unicode). False otherwise. + """ + + try: + # gets the dynamic library used by the interpretor for curses + + import _curses + cursesLib = _curses.__file__ + + # Uses 'ldd' (Linux) or 'otool -L' (Mac) to determine the curses + # library dependencies. + # + # atagar@fenrir:~/Desktop$ ldd /usr/lib/python2.6/lib-dynload/_curses.so + # linux-gate.so.1 => (0x00a51000) + # libncursesw.so.5 => /lib/libncursesw.so.5 (0x00faa000) + # libpthread.so.0 => /lib/tls/i686/cmov/libpthread.so.0 (0x002f1000) + # libc.so.6 => /lib/tls/i686/cmov/libc.so.6 (0x00158000) + # libdl.so.2 => /lib/tls/i686/cmov/libdl.so.2 (0x00398000) + # /lib/ld-linux.so.2 (0x00ca8000) + # + # atagar$ otool -L /System/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/lib-dynload/_curses.so + # /System/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/lib-dynload/_curses.so: + # /usr/lib/libncurses.5.4.dylib (compatibility version 5.4.0, current version 5.4.0) + # /usr/lib/libgcc_s.1.dylib (compatibility version 1.0.0, current version 1.0.0) + # /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 111.1.6) + + libDependencyLines = None + if sysTools.isAvailable("ldd"): + libDependencyLines = sysTools.call("ldd %s" % cursesLib) + elif sysTools.isAvailable("otool"): + libDependencyLines = sysTools.call("otool -L %s" % cursesLib) + + if libDependencyLines: + for line in libDependencyLines: + if "libncursesw" in line: return True + except: pass + + return False + def _initColors(): """ Initializes color mappings usable by curses. This can only be done after

1 0

[arm/release] fix: Unicode init needs to be before curses
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit d8ebaa88886c0aeb421623416990bd3058b175f9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 21 13:36:19 2011 -0700 fix: Unicode init needs to be before curses The locale needs to be set before initializing curses for unicode characters to be rendered. --- src/cli/controller.py | 6 ------ src/starter.py | 7 +++++++ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 8222da8..d9895e6 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -4,7 +4,6 @@ user input to the proper panels. """ import time -import locale import curses import threading @@ -460,11 +459,6 @@ def drawTorMonitor(stdscr, startTime): try: curses.curs_set(0) except curses.error: pass - # If using our LANG variable for rendering multi-byte characters lets us - # get unicode support then then use it. - if uiTools.isUnicodeAvailable(): - locale.setlocale(locale.LC_ALL, "") - # logs the initialization time msg = "arm started (initialization took %0.3f seconds)" % (time.time() - startTime) log.log(CONFIG["log.startTime"], msg) diff --git a/src/starter.py b/src/starter.py index 84abbca..9268351 100644 --- a/src/starter.py +++ b/src/starter.py @@ -10,6 +10,7 @@ import os import sys import time import getopt +import locale import socket import platform @@ -397,5 +398,11 @@ if __name__ == '__main__': procName.renameProcess("arm\0%s" % "\0".join(sys.argv[1:])) except: pass + # If using our LANG variable for rendering multi-byte characters lets us + # get unicode support then then use it. This needs to be done before + # initializing curses. + if util.uiTools.isUnicodeAvailable(): + locale.setlocale(locale.LC_ALL, "") + cli.controller.startTorMonitor(time.time() - initTime)

1 0