- tor-commits - lists.torproject.org

[arm/master] Using SAVECONF when able to persist torrc
by atagar＠torproject.org 12 May '11

12 May '11

commit d28bb39099548f46c97a1a11e5dd31bae0a47e41 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 11 21:42:05 2011 -0700 Using SAVECONF when able to persist torrc Moving config saving to the torConfig utility, and making it save via SAVECONF if it's equivilant (the contents and destination matches tor's state). This also includes other minor fixes and changes (like a bit more logging). --- src/cli/configPanel.py | 28 ++++--------------- src/util/torConfig.py | 69 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 22 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index 6ec3fce..7c1a62e 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -3,14 +3,13 @@ Panel presenting the configuration state for tor or arm. Options can be edited and the resulting configuration files saved. """ -import os import curses import threading import controller import popups -from util import conf, enum, panel, torTools, torConfig, uiTools +from util import conf, enum, panel, sysTools, torConfig, torTools, uiTools DEFAULT_CONFIG = {"features.config.selectionDetails.height": 6, "features.config.prepopulateEditValues": True, @@ -401,35 +400,20 @@ class ConfigPanel(panel.Panel): elif key == curses.KEY_RIGHT: selection = min(len(selectionOptions) - 1, selection + 1) if selection in (0, 1): - loadedTorrc = torConfig.getTorrc() + loadedTorrc, promptCanceled = torConfig.getTorrc(), False try: configLocation = loadedTorrc.getConfigLocation() except IOError: configLocation = "" if selection == 1: # prompts user for a configuration location configLocation = popups.inputPrompt("Save to (esc to cancel): ", configLocation) - if configLocation: configLocation = os.path.abspath(configLocation) + if not configLocation: promptCanceled = True - if configLocation: + if not promptCanceled: try: - # make dir if the path doesn't already exist - baseDir = os.path.dirname(configLocation) - if not os.path.exists(baseDir): os.makedirs(baseDir) - - # saves the configuration to the file - configFile = open(configLocation, "w") - configFile.write("\n".join(configLines)) - configFile.close() - - # reloads the cached torrc if overwriting it - if configLocation == loadedTorrc.getConfigLocation(): - try: - loadedTorrc.load() - panels["torrc"]._lastContentHeightArgs = None - except IOError: pass - + torConfig.saveConf(configLocation, configLines) msg = "Saved configuration to %s" % configLocation - except (IOError, OSError), exc: + except IOError, exc: msg = "Unable to save configuration (%s)" % sysTools.getFileErrorMsg(exc) popups.showMsg(msg, 2) diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 030a169..4a25f0f 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -3,6 +3,7 @@ Helper functions for working with tor's configuration file. """ import os +import time import socket import threading @@ -381,6 +382,74 @@ def getCustomOptions(includeValue = False): if includeValue: return configLines else: return [line[:line.find(" ")] for line in configLines] +def saveConf(destination = None, contents = None): + """ + Saves the configuration to the given path. If this is equivilant to + issuing a SAVECONF (the contents and destination match what tor's using) + then that's done. Otherwise, this writes the contents directly. This raises + an IOError if unsuccessful. + + Arguments: + destination - path to be saved to, the current config location if None + contents - configuration to be saved, the current config if None + """ + + if destination: + destination = os.path.abspath(destination) + + # fills default config values, and sets isSaveconf to false if they differ + # from the arguments + isSaveconf, startTime = True, time.time() + + currentConfig = getCustomOptions(True) + if not contents: contents = currentConfig + else: isSaveconf &= contents == currentConfig + + currentLocation = None + try: + currentLocation = getConfigLocation() + if not destination: destination = currentLocation + else: isSaveconf &= destination == currentLocation + except IOError: pass + + if not destination: raise IOError("unable to determine the torrc's path") + logMsg = "Saved config by %%s to %s (runtime: %%0.4f)" % destination + + # attempts SAVECONF if we're updating our torrc with the current state + if isSaveconf: + try: + torTools.getConn().getTorCtl().save_conf() + + try: getTorrc().load() + except IOError: pass + + log.log(log.DEBUG, logMsg % ("SAVECONF", time.time() - startTime)) + return # if successful then we're done + except: + # example error: + # TorCtl.TorCtl.ErrorReply: 551 Unable to write configuration to disk. + pass + + # if the SAVECONF fails or this is a custom save then write contents directly + try: + # make dir if the path doesn't already exist + baseDir = os.path.dirname(destination) + if not os.path.exists(baseDir): os.makedirs(baseDir) + + # saves the configuration to the file + configFile = open(destination, "w") + configFile.write("\n".join(contents)) + configFile.close() + except (IOError, OSError), exc: + raise IOError(exc) + + # reloads the cached torrc if overwriting it + if destination == currentLocation: + try: getTorrc().load() + except IOError: pass + + log.log(log.DEBUG, logMsg % ("directly writing", time.time() - startTime)) + def validate(contents = None): """ Performs validation on the given torrc contents, providing back a listing of

1 0

[arm/master] fix: Misparsing config types for old tor versions
by atagar＠torproject.org 12 May '11

12 May '11

commit 3d11f21692fbb30589181c1ed66e71250ffc89e6 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 12 07:53:58 2011 -0700 fix: Misparsing config types for old tor versions Queries of "GETINFO config/names" can provide documentation as an optional third argument. This only appears to happen for older tor versions (like 0.2.1.25). I was misparsing this, so the documentation was considered to be part of the argument type. --- src/cli/configPanel.py | 7 +++++-- 1 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index 7c1a62e..13e4343 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -203,9 +203,12 @@ class ConfigPanel(panel.Panel): configOptionLines = conn.getInfo("config/names", "").strip().split("\n") for line in configOptionLines: - # lines are of the form "<option> <type>", like: + # lines are of the form "<option> <type>[ <documentation>]", like: # UseEntryGuards Boolean - confOption, confType = line.strip().split(" ", 1) + # documentation is aparently only in older versions (for instance, + # 0.2.1.25) + lineComp = line.strip().split(" ") + confOption, confType = lineComp[0], lineComp[1] # skips private and virtual entries if not configured to show them if not self._config["features.config.state.showPrivateOptions"] and confOption.startswith("__"):

1 0

[arm/master] fix: Flushing torrc display cache when invisible
by atagar＠torproject.org 12 May '11

12 May '11

commit 80003ef45f1e4280f47fbbb0b39f2c74f75907de Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 11 21:10:08 2011 -0700 fix: Flushing torrc display cache when invisible Previously overwriting our torrc by saving it would flush this cache, but at its new location in the config panel this isn't a great option (I'm trying to avoid cross-panel communication). A better solution is to just flush this cache whenever we're turned invisible. --- src/cli/torrcPanel.py | 6 ++++++ 1 files changed, 6 insertions(+), 0 deletions(-) diff --git a/src/cli/torrcPanel.py b/src/cli/torrcPanel.py index 75ddd1b..af6f4d6 100644 --- a/src/cli/torrcPanel.py +++ b/src/cli/torrcPanel.py @@ -77,6 +77,12 @@ class TorrcPanel(panel.Panel): self.valsLock.release() return isKeystrokeConsumed + def setVisible(self, isVisible): + if not isVisible: + self._lastContentHeightArgs = None # redraws when next displayed + + panel.Panel.setVisible(self, isVisible) + def getHelp(self): options = [] options.append(("up arrow", "scroll up a line", None))

1 0

[arm/master] Moving descriptor popup out of the controller
by atagar＠torproject.org 12 May '11

12 May '11

commit dd1bde92b4d9b564cccb9bbd6fa3ba44fe3b41db Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 12 09:37:59 2011 -0700 Moving descriptor popup out of the controller Putting descriptor popup triggering into the connection panel, and revising descriptorPopup.py to use new styled popups. --- src/cli/connections/connPanel.py | 4 +++ src/cli/controller.py | 17 ------------ src/cli/descriptorPopup.py | 52 ++++++++++++++++++++++---------------- src/cli/popups.py | 5 ++- 4 files changed, 37 insertions(+), 41 deletions(-) diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 8ecffc2..7fab33e 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -6,6 +6,7 @@ import time import curses import threading +import cli.descriptorPopup import cli.popups from cli.connections import entries, connEntry, circEntry @@ -191,6 +192,9 @@ class ConnectionPanel(panel.Panel, threading.Thread): # applies new setting if selection != -1: self.setListingType(options[selection]) + elif key == ord('d') or key == ord('D'): + # presents popup for raw consensus data + cli.descriptorPopup.showDescriptorPopup(self) else: isKeystrokeConsumed = False self.valsLock.release() diff --git a/src/cli/controller.py b/src/cli/controller.py index c4b9442..20a4e7e 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -954,23 +954,6 @@ def drawTorMonitor(stdscr, startTime, loggedEvents, isBlindMode): setPauseState(panels, isPaused, page) finally: panel.CURSES_LOCK.release() - elif page == 1 and key in (ord('d'), ord('D')): - # presents popup for raw consensus data - panel.CURSES_LOCK.acquire() - try: - setPauseState(panels, isPaused, page, True) - curses.cbreak() # wait indefinitely for key presses (no timeout) - panelTitle = panels["conn"]._title - panels["conn"]._title = "" - panels["conn"].redraw(True) - - descriptorPopup.showDescriptorPopup(panels["popup"], stdscr, panels["conn"]) - - panels["conn"]._title = panelTitle - setPauseState(panels, isPaused, page) - curses.halfdelay(REFRESH_RATE * 10) # reset normal pausing behavior - finally: - panel.CURSES_LOCK.release() else: for pagePanel in getPanels(page + 1): isKeystrokeConsumed = pagePanel.handleKey(key) diff --git a/src/cli/descriptorPopup.py b/src/cli/descriptorPopup.py index d57546c..920f2bc 100644 --- a/src/cli/descriptorPopup.py +++ b/src/cli/descriptorPopup.py @@ -7,6 +7,7 @@ import curses import controller import connections.connEntry +import popups from util import panel, torTools, uiTools # field keywords used to identify areas for coloring @@ -65,7 +66,7 @@ class PopupProperties: elif key == curses.KEY_PPAGE: self.scroll = max(self.scroll - height, 0) elif key == curses.KEY_NPAGE: self.scroll = max(0, min(self.scroll + height, len(self.text) - height)) -def showDescriptorPopup(popup, stdscr, connectionPanel): +def showDescriptorPopup(connectionPanel): """ Presents consensus descriptor in popup window with the following controls: Up, Down, Page Up, Page Down - scroll descriptor @@ -73,10 +74,16 @@ def showDescriptorPopup(popup, stdscr, connectionPanel): Enter, Space, d, D - close popup """ + # hides the title of the first panel on the page + topPanel = controller.getPanels(controller.getPage())[0] + topPanel.setTitleVisible(False) + topPanel.redraw(True) + properties = PopupProperties() isVisible = True - if not panel.CURSES_LOCK.acquire(False): return + panel.CURSES_LOCK.acquire() + try: while isVisible: selection = connectionPanel._scroller.getCursorSelection(connectionPanel._entryLines) @@ -96,29 +103,30 @@ def showDescriptorPopup(popup, stdscr, connectionPanel): # tracks number of extra lines that will be taken due to text wrap height += (lineWidth - 2) / connectionPanel.maxX - popup.setHeight(min(len(properties.text) + height + 2, connectionPanel.maxY)) - popup.recreate(stdscr, width) - while isVisible: - draw(popup, properties) - key = stdscr.getch() + popupHeight = min(len(properties.text) + height + 2, connectionPanel.maxY) + popup, _, _ = popups.init(popupHeight, width) + if not popup: break - if uiTools.isSelectionKey(key) or key in (ord('d'), ord('D')): - # closes popup - isVisible = False - elif key in (curses.KEY_LEFT, curses.KEY_RIGHT): - # navigation - pass on to connPanel and recreate popup - connectionPanel.handleKey(curses.KEY_UP if key == curses.KEY_LEFT else curses.KEY_DOWN) - break - else: properties.handleKey(key, popup.height - 2) - - popup.setHeight(9) - popup.recreate(stdscr, 80) - finally: - panel.CURSES_LOCK.release() + try: + draw(popup, properties) + key = controller.getScreen().getch() + + if uiTools.isSelectionKey(key) or key in (ord('d'), ord('D')): + # closes popup + isVisible = False + elif key in (curses.KEY_LEFT, curses.KEY_RIGHT): + # navigation - pass on to connPanel and recreate popup + connectionPanel.handleKey(curses.KEY_UP if key == curses.KEY_LEFT else curses.KEY_DOWN) + break + else: properties.handleKey(key, popup.height - 2) + finally: popups.finalize() + finally: panel.CURSES_LOCK.release() + + topPanel.setTitleVisible(True) def draw(popup, properties): - popup.clear() + popup.win.erase() popup.win.box() xOffset = 2 @@ -174,5 +182,5 @@ def draw(popup, properties): lineNum += 1 if lineNum > pageHeight: break - popup.refresh() + popup.win.refresh() diff --git a/src/cli/popups.py b/src/cli/popups.py index 2b02685..de4bad6 100644 --- a/src/cli/popups.py +++ b/src/cli/popups.py @@ -301,9 +301,10 @@ def showMenu(title, options, oldSelection): elif key == curses.KEY_DOWN: selection = min(len(options) - 1, selection + 1) elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel - topPanel.setTitleVisible(True) curses.halfdelay(controller.REFRESH_RATE * 10) # reset normal pausing behavior - finally: finalize() + finally: + topPanel.setTitleVisible(True) + finalize() return selection

1 0

[tor/master] Clean up a formatting issue on the manpge; bug3154.
by nickm＠torproject.org 12 May '11

12 May '11

commit 2c88dd7f95604f445f05976dd2d34847e065349f Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:36:20 2011 -0400 Clean up a formatting issue on the manpge; bug3154. --- doc/tor.1.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 00d5066..fb4b3f9 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -325,7 +325,7 @@ Other options can be specified either on the command-line (--option **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ + -**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog** :: +**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**:: As above, but select messages by range of log severity __and__ by a set of "logging domains". Each logging domain corresponds to an area of functionality inside Tor. You can specify any number of severity ranges

1 0

[tor/master] Merge remote-tracking branch 'origin/maint-0.2.2'
by nickm＠torproject.org 12 May '11

12 May '11

commit 8fa7bcead5d8344b80ee295f3c1e0e15fd37ba87 Merge: 621e95a 2c88dd7 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:36:41 2011 -0400 Merge remote-tracking branch 'origin/maint-0.2.2' doc/tor.1.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)

1 0

[tor/maint-0.2.2] Clean up a formatting issue on the manpge; bug3154.
by nickm＠torproject.org 12 May '11

12 May '11

commit 2c88dd7f95604f445f05976dd2d34847e065349f Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:36:20 2011 -0400 Clean up a formatting issue on the manpge; bug3154. --- doc/tor.1.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 00d5066..fb4b3f9 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -325,7 +325,7 @@ Other options can be specified either on the command-line (--option **Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **file** __FILENAME__ + -**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog** :: +**Log** **[**__domain__,...**]**__minSeverity__[-__maxSeverity__] ... **stderr**|**stdout**|**syslog**:: As above, but select messages by range of log severity __and__ by a set of "logging domains". Each logging domain corresponds to an area of functionality inside Tor. You can specify any number of severity ranges

1 0

[tor/master] Unmap microdesc cache before replacing it.
by nickm＠torproject.org 12 May '11

12 May '11

commit bdff7e3299d78cd2f7aa4a31e5f57c1aeef5ffa1 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:19:52 2011 -0400 Unmap microdesc cache before replacing it. If we do a replace-then-munmap, windows will never actually rewrite the microdesc cache. Found by wanoskarnet; bugfix on 0.2.2.6-alpha. --- changes/md_cache_replace | 6 ++++++ src/or/microdesc.c | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/changes/md_cache_replace b/changes/md_cache_replace new file mode 100644 index 0000000..88e029c --- /dev/null +++ b/changes/md_cache_replace @@ -0,0 +1,6 @@ + o Minor bugfixes + - Avoid a bug that would keep us from replacing a microdescriptor + cache on Windows. (We would try to replace the file while still + holding it open. That's fine on Unix, but Windows doesn't let us + do that.) Bugfix on 0.2.2.6-alpha; bug found by wanoskarnet. + diff --git a/src/or/microdesc.c b/src/or/microdesc.c index 5740c40..1554aca 100644 --- a/src/or/microdesc.c +++ b/src/or/microdesc.c @@ -399,10 +399,11 @@ microdesc_cache_rebuild(microdesc_cache_t *cache, int force) smartlist_add(wrote, md); } - finish_writing_to_file(open_file); /*XXX Check me.*/ - if (cache->cache_content) tor_munmap_file(cache->cache_content); + + finish_writing_to_file(open_file); /*XXX Check me.*/ + cache->cache_content = tor_mmap_file(cache->cache_fname); if (!cache->cache_content && smartlist_len(wrote)) {

1 0

[tor/master] Merge remote-tracking branch 'origin/maint-0.2.2'
by nickm＠torproject.org 12 May '11

12 May '11

commit 621e95a4f3e1e896ee41e261f5e0c953fb6101a9 Merge: 3968e8d bdff7e3 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:21:59 2011 -0400 Merge remote-tracking branch 'origin/maint-0.2.2' changes/md_cache_replace | 6 ++++++ src/or/microdesc.c | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-)

1 0

[tor/maint-0.2.2] Unmap microdesc cache before replacing it.
by nickm＠torproject.org 12 May '11

12 May '11

commit bdff7e3299d78cd2f7aa4a31e5f57c1aeef5ffa1 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu May 12 11:19:52 2011 -0400 Unmap microdesc cache before replacing it. If we do a replace-then-munmap, windows will never actually rewrite the microdesc cache. Found by wanoskarnet; bugfix on 0.2.2.6-alpha. --- changes/md_cache_replace | 6 ++++++ src/or/microdesc.c | 5 +++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/changes/md_cache_replace b/changes/md_cache_replace new file mode 100644 index 0000000..88e029c --- /dev/null +++ b/changes/md_cache_replace @@ -0,0 +1,6 @@ + o Minor bugfixes + - Avoid a bug that would keep us from replacing a microdescriptor + cache on Windows. (We would try to replace the file while still + holding it open. That's fine on Unix, but Windows doesn't let us + do that.) Bugfix on 0.2.2.6-alpha; bug found by wanoskarnet. + diff --git a/src/or/microdesc.c b/src/or/microdesc.c index 5740c40..1554aca 100644 --- a/src/or/microdesc.c +++ b/src/or/microdesc.c @@ -399,10 +399,11 @@ microdesc_cache_rebuild(microdesc_cache_t *cache, int force) smartlist_add(wrote, md); } - finish_writing_to_file(open_file); /*XXX Check me.*/ - if (cache->cache_content) tor_munmap_file(cache->cache_content); + + finish_writing_to_file(open_file); /*XXX Check me.*/ + cache->cache_content = tor_mmap_file(cache->cache_fname); if (!cache->cache_content && smartlist_len(wrote)) {

1 0