- tor-commits - lists.torproject.org

[arm/release] Replacing quit confirmation to use the popup util
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 9ddfb9127a41991428736d98ef075cd77817eda4 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 12 21:13:01 2011 -0700 Replacing quit confirmation to use the popup util --- src/cli/controller.py | 21 +++------------------ 1 files changed, 3 insertions(+), 18 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 1189781..6c26d81 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -686,24 +686,9 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # provides prompt to confirm that arm should exit if CONFIRM_QUIT: - panel.CURSES_LOCK.acquire() - try: - setPauseState(panels, isPaused, page, True) - - # provides prompt - panels["control"].setMsg("Are you sure (q again to confirm)?", curses.A_BOLD) - panels["control"].redraw(True) - - curses.cbreak() - confirmationKey = stdscr.getch() - quitConfirmed = confirmationKey in (ord('q'), ord('Q')) - curses.halfdelay(REFRESH_RATE * 10) - - if not quitConfirmed: - panels["control"].setMsg(CTL_PAUSED if isPaused else CTL_HELP) - setPauseState(panels, isPaused, page) - finally: - panel.CURSES_LOCK.release() + msg = "Are you sure (q again to confirm)?" + confirmationKey = popups.showMsg(msg, attr = curses.A_BOLD) + quitConfirmed = confirmationKey in (ord('q'), ord('Q')) if quitConfirmed: # quits arm

1 0

[arm/release] Removing last references to the old style popups
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit fc16a755e7140e8d5aa6d502053e5109078cacc9 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 12 21:17:39 2011 -0700 Removing last references to the old style popups Dropping the ancient Popup class and removing the static panel reference that was previously used for all popups. All of its actual uses have been removed in the previous set of commits to use the new popup utils. --- src/cli/controller.py | 61 ++++--------------------------------------------- 1 files changed, 5 insertions(+), 56 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 6c26d81..51b64c7 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -89,7 +89,7 @@ REFRESH_RATE = 5 # seconds between redrawing screen CTL_HELP, CTL_PAUSED = range(2) # panel order per page -PAGE_S = ["header", "control", "popup"] # sticky (ie, always available) page +PAGE_S = ["header", "control"] # sticky (ie, always available) page PAGES = [ ["graph", "log"], ["conn"], @@ -182,46 +182,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 Popup(panel.Panel): - """ - Temporarily providing old panel methods until permanent workaround for popup - can be derrived (this passive drawing method is horrible - I'll need to - provide a version using the more active repaint design later in the - revision). - """ - - def __init__(self, stdscr, height): - panel.Panel.__init__(self, stdscr, "popup", 0, height) - - def setPaused(self, isPause): - panel.Panel.setPaused(self, isPause, True) - - # The following methods are to emulate old panel functionality (this was the - # only implementations to use these methods and will require a complete - # rewrite when refactoring gets here) - def clear(self): - if self.win: - self.isDisplaced = self.top > self.win.getparyx()[0] - if not self.isDisplaced: self.win.erase() - - def refresh(self): - if self.win and not self.isDisplaced: self.win.refresh() - - def recreate(self, stdscr, newWidth=-1, newTop=None): - self.setParent(stdscr) - self.setWidth(newWidth) - if newTop != None: self.setTop(newTop) - - newHeight, newWidth = self.getPreferredSize() - if newHeight > 0: - self.win = self.parent.subwin(newHeight, newWidth, self.top, 0) - elif self.win == None: - # don't want to leave the window as none (in very edge cases could cause - # problems) - rather, create a displaced instance - self.win = self.parent.subwin(1, newWidth, 0, 0) - - self.maxY, self.maxX = self.win.getmaxyx() - def addstr_wrap(panel, y, x, text, formatting, startX = 0, endX = -1, maxY = -1): """ Writes text with word wrapping, returning the ending y/x coordinate. @@ -435,7 +395,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panels = { "header": headerPanel.HeaderPanel(stdscr, startTime, config), - "popup": Popup(stdscr, 9), "graph": graphing.graphPanel.GraphPanel(stdscr), "log": logPanel.LogPanel(stdscr, loggedEvents, config)} @@ -516,7 +475,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): isPaused = False # if true updates are frozen overrideKey = None # immediately runs with this input rather than waiting for the user if set page = 0 - panels["popup"].redraw(True) # hack to make sure popup has a window instance (not entirely sure why...) PAGE = page @@ -599,8 +557,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): panels[panelKey].setTop(startY) startY += panels[panelKey].getHeight() - panels["popup"].recreate(stdscr, 80, startY) - for panelSet in PAGES: tmpStartY = startY @@ -627,17 +583,10 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # I haven't the foggiest why, but doesn't work if redrawn out of order... for panelKey in (PAGE_S + PAGES[page]): - # redrawing popup can result in display flicker when it should be hidden - if panelKey != "popup": - newSize = stdscr.getmaxyx() - isResize = lastSize != newSize - lastSize = newSize - - if panelKey in ("header", "graph", "log", "config", "torrc", "conn2"): - # revised panel (manages its own content refreshing) - panels[panelKey].redraw(isResize) - else: - panels[panelKey].redraw(True) + newSize = stdscr.getmaxyx() + isResize = lastSize != newSize + lastSize = newSize + panels[panelKey].redraw(isResize) stdscr.refresh()

1 0

[arm/release] fix: Control message lagging being state
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 6a22d0c090846fe2ffb3dbb5a971cd6831d79bfb Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 07:35:13 2011 -0700 fix: Control message lagging being state The control panel is the last of the old-style panels and doesn't yet support non-forced redraws. --- src/cli/controller.py | 6 +++++- src/util/procName.py | 22 ++++++++++++---------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 51b64c7..5927e17 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -586,7 +586,11 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): newSize = stdscr.getmaxyx() isResize = lastSize != newSize lastSize = newSize - panels[panelKey].redraw(isResize) + + if panelKey != "control": + panels[panelKey].redraw(isResize) + else: + panels[panelKey].redraw(True) stdscr.refresh() diff --git a/src/util/procName.py b/src/util/procName.py index 97dc707..fab0b1e 100644 --- a/src/util/procName.py +++ b/src/util/procName.py @@ -1,13 +1,15 @@ -# Module to allow for arbitrary renaming of our python process. This is mostly -# based on: -# http://www.rhinocerus.net/forum/lang-python/569677-setting-program-name-lik… -# and an adaptation by Jake: https://github.com/ioerror/chameleon -# -# A cleaner implementation is available at: -# https://github.com/cream/libs/blob/b38970e2a6f6d2620724c828808235be0445b799… -# but I'm not quite clear on their implementation, and it only does targeted -# argument replacement (ie, replace argv[0], argv[1], etc but with a string -# the same size). +""" +Module to allow for arbitrary renaming of our python process. This is mostly +based on: +http://www.rhinocerus.net/forum/lang-python/569677-setting-program-name-like-0-perl.html#post2272369 +and an adaptation by Jake: https://github.com/ioerror/chameleon + +A cleaner implementation is available at: +https://github.com/cream/libs/blob/b38970e2a6f6d2620724c828808235be0445b799/cream/util/procname.py +but I'm not quite clear on their implementation, and it only does targeted +argument replacement (ie, replace argv[0], argv[1], etc but with a string +the same size). +""" import sys import ctypes

1 0

[arm/release] Moving torrc log load warnings to the torrc class
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 072fcb45439099e61716bb3edfee8cbc81f6887a Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 19:04:51 2011 -0700 Moving torrc log load warnings to the torrc class Minor refactoring change so warnings are an option of the load method. --- src/cli/controller.py | 16 +++++----------- src/util/torConfig.py | 15 ++++++++++++++- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index eb1df4f..d44b811 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -96,8 +96,7 @@ PAGES = [ ["config"], ["torrc"]] -CONFIG = {"log.torrc.readFailed": log.WARN, - "features.graph.type": 1, +CONFIG = {"features.graph.type": 1, "queries.refreshRate.rate": 5, "log.torEventTypeUnrecognized": log.NOTICE, "features.graph.bw.prepopulate": True, @@ -286,11 +285,8 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): loadedTorrc = torConfig.getTorrc() loadedTorrc.getLock().acquire() - try: - loadedTorrc.load() - except IOError, exc: - msg = "Unable to load torrc (%s)" % sysTools.getFileErrorMsg(exc) - log.log(CONFIG["log.torrc.readFailed"], msg) + try: loadedTorrc.load(True) + except: pass if loadedTorrc.isLoaded(): corrections = loadedTorrc.getCorrections() @@ -504,11 +500,9 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): # reload the torrc if it's previously been loaded if loadedTorrc.isLoaded(): try: - loadedTorrc.load() + loadedTorrc.load(True) if page == 3: panels["torrc"].redraw(True) - except IOError, exc: - msg = "Unable to load torrc (%s)" % sysTools.getFileErrorMsg(exc) - log.log(CONFIG["log.torrc.readFailed"], msg) + except: pass sighupTracker.isReset = False diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 4a25f0f..a083099 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -22,6 +22,7 @@ CONFIG = {"features.torrc.validate": True, "torrc.label.time.hour": [], "torrc.label.time.day": [], "torrc.label.time.week": [], + "log.torrc.readFailed": log.WARN, "log.configDescriptions.unrecognizedCategory": log.NOTICE} # enums and values for numeric torrc entries @@ -616,11 +617,18 @@ class Torrc(): self.displayableContents = None self.strippedContents = None self.corrections = None + + # flag to indicate if we've given a load failure warning before + self.isLoadFailWarned = False - def load(self): + def load(self, logFailure = False): """ Loads or reloads the torrc contents, raising an IOError if there's a problem. + + Arguments: + logFailure - if the torrc fails to load and we've never provided a + warning for this before then logs a warning """ self.valsLock.acquire() @@ -637,6 +645,11 @@ class Torrc(): self.contents = configFile.readlines() configFile.close() except IOError, exc: + if logFailure and not self.isLoadFailWarned: + msg = "Unable to load torrc (%s)" % sysTools.getFileErrorMsg(exc) + log.log(CONFIG["log.torrc.readFailed"], msg) + self.isLoadFailWarned = True + self.valsLock.release() raise exc

1 0

[arm/release] Banishing addstr_wrap from the controller
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit e1c3ca099effe77b00c7ad86872598e54f66aa51 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 18:29:16 2011 -0700 Banishing addstr_wrap from the controller The descriptorPopup is destined to be dropped from the codebase once I write the controller prompt, and this is also the last usage of the deprecated addstr_wrap function. Rather than rewriting the popup to use an alternative I'm just puting all the soon-to-be-dead code to one place. --- src/cli/controller.py | 29 ----------------------------- src/cli/descriptorPopup.py | 33 +++++++++++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 5927e17..eb1df4f 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -182,35 +182,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) -def addstr_wrap(panel, y, x, text, formatting, startX = 0, endX = -1, maxY = -1): - """ - Writes text with word wrapping, returning the ending y/x coordinate. - y: starting write line - x: column offset from startX - text / formatting: content to be written - startX / endX: column bounds in which text may be written - """ - - # moved out of panel (trying not to polute new code!) - # TODO: unpleaseantly complex usage - replace with something else when - # rewriting confPanel and descriptorPopup (the only places this is used) - if not text: return (y, x) # nothing to write - if endX == -1: endX = panel.maxX # defaults to writing to end of panel - if maxY == -1: maxY = panel.maxY + 1 # defaults to writing to bottom of panel - lineWidth = endX - startX # room for text - while True: - if len(text) > lineWidth - x - 1: - chunkSize = text.rfind(" ", 0, lineWidth - x) - writeText = text[:chunkSize] - text = text[chunkSize:].strip() - - panel.addstr(y, x + startX, writeText, formatting) - y, x = y + 1, 0 - if y >= maxY: return (y, x) - else: - panel.addstr(y, x + startX, text, formatting) - return (y, x + len(text)) - class sighupListener(TorCtl.PostEventListener): """ Listens for reload signal (hup), which is produced by: diff --git a/src/cli/descriptorPopup.py b/src/cli/descriptorPopup.py index 920f2bc..2a51905 100644 --- a/src/cli/descriptorPopup.py +++ b/src/cli/descriptorPopup.py @@ -22,6 +22,35 @@ SIG_END_KEYS = ["-----END RSA PUBLIC KEY-----", "-----END SIGNATURE-----"] UNRESOLVED_MSG = "No consensus data available" ERROR_MSG = "Unable to retrieve data" +def addstr_wrap(panel, y, x, text, formatting, startX = 0, endX = -1, maxY = -1): + """ + Writes text with word wrapping, returning the ending y/x coordinate. + y: starting write line + x: column offset from startX + text / formatting: content to be written + startX / endX: column bounds in which text may be written + """ + + # moved out of panel (trying not to polute new code!) + # TODO: unpleaseantly complex usage - replace with something else when + # rewriting confPanel and descriptorPopup (the only places this is used) + if not text: return (y, x) # nothing to write + if endX == -1: endX = panel.maxX # defaults to writing to end of panel + if maxY == -1: maxY = panel.maxY + 1 # defaults to writing to bottom of panel + lineWidth = endX - startX # room for text + while True: + if len(text) > lineWidth - x - 1: + chunkSize = text.rfind(" ", 0, lineWidth - x) + writeText = text[:chunkSize] + text = text[chunkSize:].strip() + + panel.addstr(y, x + startX, writeText, formatting) + y, x = y + 1, 0 + if y >= maxY: return (y, x) + else: + panel.addstr(y, x + startX, text, formatting) + return (y, x + len(text)) + class PopupProperties: """ State attributes of popup window for consensus descriptions. @@ -176,8 +205,8 @@ def draw(popup, properties): keyword, remainder = lineText, "" keywordFormat = uiTools.getColor(SIG_COLOR) - lineNum, xLoc = controller.addstr_wrap(popup, lineNum, 0, keyword, keywordFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) - lineNum, xLoc = controller.addstr_wrap(popup, lineNum, xLoc, remainder, remainderFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) + lineNum, xLoc = addstr_wrap(popup, lineNum, 0, keyword, keywordFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) + lineNum, xLoc = addstr_wrap(popup, lineNum, xLoc, remainder, remainderFormat, xOffset + numOffset, popup.maxX - 1, popup.maxY - 1) lineNum += 1 if lineNum > pageHeight: break

1 0

[arm/release] fix: Log panel busy wait during curses lock
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 6f46b55a97e67922d5d6aa1b1ec8340e5085a406 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 08:17:13 2011 -0700 fix: Log panel busy wait during curses lock If we registered events while the curses lock was held (for instance with a popup or prompt for user input) then arm would peg the cpu. The reason for this was that the log panel was attempting to redraw itself, but not registering any of the attempts since they all failed so it became a busy wait. --- src/cli/logPanel.py | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index 34bf759..6d54ab4 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -1079,6 +1079,10 @@ class LogPanel(panel.Panel, threading.Thread): else: lastDay = currentDay self.redraw(True) + + # makes sure that we register this as an update, otherwise lacking the + # curses lock can cause a busy wait here + self._lastUpdate = time.time() def stop(self): """

1 0

[arm/release] Expanding connection line selection by a space
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 860511ce71e2ad947014271bd2517624fb38289e Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 18:21:43 2011 -0700 Expanding connection line selection by a space The connection panel looks a little better if selection hilighting stretches all the way to the left window edge. --- src/cli/connections/circEntry.py | 4 +++- src/cli/connections/connEntry.py | 6 ++++-- src/cli/connections/connPanel.py | 4 ++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/src/cli/connections/circEntry.py b/src/cli/connections/circEntry.py index b15b26a..82ef0ff 100644 --- a/src/cli/connections/circEntry.py +++ b/src/cli/connections/circEntry.py @@ -177,13 +177,14 @@ class CircLine(connEntry.ConnectionLine): lineFormat = uiTools.getColor(connEntry.CATEGORY_COLOR[self.getType()]) # The required widths are the sum of the following: + # initial space (1 character) # bracketing (3 characters) # placementLabel (14 characters) # gap between etc and placement label (5 characters) if self.isLast: bracket = (curses.ACS_LLCORNER, curses.ACS_HLINE, ord(' ')) else: bracket = (curses.ACS_VLINE, ord(' '), ord(' ')) - baselineSpace = len(bracket) + 14 + 5 + baselineSpace = len(bracket) + 14 + 5 + 1 dst, etc = "", "" if listingType == entries.ListingType.IP_ADDRESS: @@ -212,5 +213,6 @@ class CircLine(connEntry.ConnectionLine): drawEntry = uiTools.DrawEntry(" " * (width - baselineSpace - len(dst) - len(etc) + 5), lineFormat, drawEntry) drawEntry = uiTools.DrawEntry(dst + etc, lineFormat, drawEntry) drawEntry = uiTools.DrawEntry(bracket, curses.A_NORMAL, drawEntry, lockFormat = True) + drawEntry = uiTools.DrawEntry(" ", curses.A_NORMAL, drawEntry, lockFormat = True) return drawEntry diff --git a/src/cli/connections/connEntry.py b/src/cli/connections/connEntry.py index ac45656..05e2a45 100644 --- a/src/cli/connections/connEntry.py +++ b/src/cli/connections/connEntry.py @@ -288,7 +288,7 @@ class ConnectionLine(entries.ConnectionPanelLine): timePrefix = "+" if self.isInitialConnection else " " else: timePrefix = "" - timeEntry = myListing.getNext() + timeEntry = myListing.getNext().getNext() timeEntry.text = timePrefix + "%5s" % uiTools.getTimeLabel(currentTime - self.startTime, 1) return myListing @@ -304,6 +304,7 @@ class ConnectionLine(entries.ConnectionPanelLine): entryType = self.getType() # Lines are split into the following components in reverse: + # init gap - " " # content - "<src> --> <dst> <etc> " # time - "<uptime>" # preType - " (" @@ -317,7 +318,8 @@ class ConnectionLine(entries.ConnectionPanelLine): drawEntry = uiTools.DrawEntry(entryType.upper(), lineFormat | curses.A_BOLD, drawEntry) drawEntry = uiTools.DrawEntry(" (", lineFormat, drawEntry) drawEntry = uiTools.DrawEntry(" " * timeWidth, lineFormat, drawEntry) - drawEntry = uiTools.DrawEntry(self._getListingContent(width - (12 + timeWidth), listingType), lineFormat, drawEntry) + drawEntry = uiTools.DrawEntry(self._getListingContent(width - (12 + timeWidth) - 1, listingType), lineFormat, drawEntry) + drawEntry = uiTools.DrawEntry(" ", lineFormat, drawEntry) return drawEntry def _getDetails(self, width): diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 7fab33e..45750c3 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -278,9 +278,9 @@ class ConnectionPanel(panel.Panel, threading.Thread): title = "Connection Details:" if self._showDetails else self._title self.addstr(0, 0, title, curses.A_STANDOUT) - scrollOffset = 1 + scrollOffset = 0 if isScrollbarVisible: - scrollOffset = 3 + scrollOffset = 2 self.addScrollBar(scrollLoc, scrollLoc + height - detailPanelOffset - 1, len(self._entryLines), 1 + detailPanelOffset) if self.isPaused() or not self._isTorRunning:

1 0

[arm/release] Moving torrc sighup reloads to the torrc panel
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 7fbbbad2e682d617157bd931ce18c1bcd3504ead Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 13 19:29:00 2011 -0700 Moving torrc sighup reloads to the torrc panel Using the new style listeners for torrc sighup listening rather than the old sighup tracker. --- src/cli/controller.py | 9 --------- src/cli/torrcPanel.py | 20 +++++++++++++++++++- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 5696daa..63f62e5 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -432,15 +432,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): if panels["graph"].currentDisplay == "bandwidth": panels["graph"].setHeight(panels["graph"].stats["bandwidth"].getContentHeight()) - # TODO: should redraw the torrcPanel - #panels["torrc"].loadConfig() - - # reload the torrc if it's previously been loaded - if loadedTorrc.isLoaded(): - try: - loadedTorrc.load(True) - if page == 3: panels["torrc"].redraw(True) - except: pass sighupTracker.isReset = False diff --git a/src/cli/torrcPanel.py b/src/cli/torrcPanel.py index af6f4d6..e14a16a 100644 --- a/src/cli/torrcPanel.py +++ b/src/cli/torrcPanel.py @@ -8,7 +8,7 @@ import threading import popups -from util import conf, enum, panel, torConfig, uiTools +from util import conf, enum, panel, torConfig, torTools, uiTools DEFAULT_CONFIG = {"features.config.file.showScrollbars": True, "features.config.file.maxLinesPerEntry": 8} @@ -40,6 +40,24 @@ class TorrcPanel(panel.Panel): # _lastContentHeightArgs is None or differs from the current dimensions) self._lastContentHeight = 1 self._lastContentHeightArgs = None + + # listens for tor reload (sighup) events + torTools.getConn().addStatusListener(self.resetListener) + + def resetListener(self, conn, eventType): + """ + Reloads and displays the torrc on tor reload (sighup) events. + + Arguments: + conn - tor controller + eventType - type of event detected + """ + + if eventType == torTools.State.INIT: + try: + torConfig.getTorrc().load(True) + self.redraw(True) + except: pass def handleKey(self, key): self.valsLock.acquire()

1 0

[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