May 2016 - tor-commits - lists.torproject.org

[translation/tails-persistence-setup] Update translations for tails-persistence-setup
by translation＠torproject.org 22 May '16

22 May '16

commit 29ca07371cf03245cd9420385bb35e0a8120ae03 Author: Translation commit bot <translation(a)torproject.org> Date: Sun May 22 02:45:23 2016 +0000 Update translations for tails-persistence-setup --- gl/gl.po | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/gl/gl.po b/gl/gl.po index 8a58dd2..bf0d331 100644 --- a/gl/gl.po +++ b/gl/gl.po @@ -5,6 +5,7 @@ # Translators: # pakoR <gmpakor(a)gmail.com>, 2015 # manuel meixide <m.meixide(a)gmail.com>, 2013 +# Martín Rolle <martinrolle99(a)gmail.com>, 2016 # Xnake, 2014 # Xnake, 2016 msgid "" @@ -12,8 +13,8 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: Tails developers <tails(a)boum.org>\n" "POT-Creation-Date: 2016-04-24 16:40+0200\n" -"PO-Revision-Date: 2016-04-25 08:33+0000\n" -"Last-Translator: carolyn <carolyn(a)anhalt.org>\n" +"PO-Revision-Date: 2016-05-22 02:44+0000\n" +"Last-Translator: Martín Rolle <martinrolle99(a)gmail.com>\n" "Language-Team: Galician (http://www.transifex.com/otf/torproject/language/gl/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -119,11 +120,11 @@ msgstr "Listas descargadas polo APT" #: ../lib/Tails/Persistence/Configuration/Presets.pm:168 msgid "Mumble server" -msgstr "" +msgstr "Servidor mumble" #: ../lib/Tails/Persistence/Configuration/Presets.pm:170 msgid "Mumble server configuration and its Tor Hidden Service address" -msgstr "" +msgstr "Configuracion do servidor mumble e o seu servizo de dirección secreta de Tor" #: ../lib/Tails/Persistence/Configuration/Presets.pm:178 msgid "Dotfiles"

1 0

[stem/master] Added Tor event descriptions
by atagar＠torproject.org 22 May '16

22 May '16

commit 56ef350477e43ae41f66292b4429012255c42493 Author: Sambuddha Basu <sambuddhabasu1(a)gmail.com> Date: Sun May 15 20:54:57 2016 -0700 Added Tor event descriptions --- stem/response/events.py | 12 ++++++++++++ stem/settings.cfg | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) diff --git a/stem/response/events.py b/stem/response/events.py index 35cc98f..50051c0 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -8,6 +8,7 @@ import time import stem import stem.control import stem.descriptor.router_status_entry +import stem.manual import stem.response import stem.version @@ -1321,6 +1322,17 @@ def _parse_cell_type_mapping(mapping): return results +def event_summary(event): + """ + Provides a description for Tor events. + + :param str event: the event for which a description is needed + + :returns: str The event description + """ + return stem.manual._config().get('event.description.%s' % event.lower(), '') + + EVENT_TYPE_TO_CLASS = { 'ADDRMAP': AddrMapEvent, 'AUTHDIR_NEWDESCS': AuthDirNewDescEvent, diff --git a/stem/settings.cfg b/stem/settings.cfg index 6395a5d..a08a6db 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -5,6 +5,10 @@ # * manual.important Most commonly used configuration options. # * manual.summary Short summary describing the option. # +# Tor and Nyx event descriptions... +# +# * event.description Descriptions for the events. +# ################################################################################ manual.important BandwidthRate @@ -362,3 +366,34 @@ manual.summary.TestingLinkKeySlop Time before expiration that we replace our ed2 manual.summary.TestingAuthKeySlop Time before expiration that we replace our ed25519 authentication key manual.summary.TestingSigningKeySlop Time before expiration that we replace our ed25519 signing key +event.description.debug Tor debug logging event. +event.description.info Tor info logging event. +event.description.notice Tor notice logging event. +event.description.warn Tor warn logging event. +event.description.err Tor error logging event. +event.description.nyx_debug Nyx debug logging event. +event.description.nyx_info Nyx info logging event. +event.description.nyx_notice Nyx notice logging event. +event.description.nyx_warn Nyx warn logging event. +event.description.nyx_error Nyx error logging event. +event.description.circ Indicates that a circuit has changed. +event.description.circ_minor Provides information about minor changes in our circuits. +event.description.stream Indicates that a stream has changed. +event.description.orconn Indicates a change in a relay connection. +event.description.bw Event emitted every second with the bytes sent and received by tor. +event.description.newdesc Indicates that a new descriptor is available. +event.description.addrmap Indicates a new address mapping. +event.description.authdir_newdescs Indicates that we just received new descriptors specific to directory authorities. +event.description.descchanged Indicates that our descriptor has changed. +event.description.ns Event for when our copy of the consensus has changed. +event.description.status_general Notification of a change in tor's state. +event.description.status_client Notification of a change in tor's state. +event.description.status_server Notification of a change in tor's state. +event.description.guard Indicates that our guard relays have changed. +event.description.stream_bw Event with the bytes sent and received by tor since the last such event on this stream. +event.description.clients_seen Periodic event on bridge relays that provide a summary of our users. +event.description.newconsensus Event for when we have a new consensus. +event.description.buildtimeout_set Indicates the timeout value for a circuit has changed. +event.description.signal Indicates that tor has received and acted upon a signal being sent to the process. +event.description.conf_changed Indicates that our configuration changed, either in a response to a SETCONF or RELOAD signal. +

1 0

[stem/master] Unit test event_summary()
by atagar＠torproject.org 22 May '16

22 May '16

commit ececfb0f8db47599b13b1e2f26281934d51d804a Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 20 08:38:47 2016 -0700 Unit test event_summary() This is a trivial function to unit test. No reason not to have coverage! --- test/unit/control/controller.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index 58df2d4..1b61e4d 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -34,6 +34,11 @@ class TestControl(unittest.TestCase): with patch('stem.control.Controller.add_event_listener', Mock()): self.controller = Controller(socket) + def test_event_summary(self): + self.assertEqual('Tor debug logging event.', stem.control.event_summary('DEBUG')) + self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_summary('BW')) + self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_summary('bw')) + @patch('stem.control.Controller.get_info') def test_get_version(self, get_info_mock): """

1 0

[stem/master] Rewording event descriptions
by atagar＠torproject.org 22 May '16

22 May '16

commit c29efb501b83d8f1cf740a9da58f42ebf073c406 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 20 10:21:58 2016 -0700 Rewording event descriptions Renaming the function to event_description() and adjusting our descriptions of events. --- stem/control.py | 4 +++- stem/settings.cfg | 47 ++++++++++++++++++++--------------------- test/unit/control/controller.py | 8 +++---- 3 files changed, 30 insertions(+), 29 deletions(-) diff --git a/stem/control.py b/stem/control.py index 0ed7e8d..a036144 100644 --- a/stem/control.py +++ b/stem/control.py @@ -66,6 +66,8 @@ If you're fine with allowing your script to raise exceptions then this can be mo :: + event_description - brief description of a tor event type + Controller - General controller class intended for direct use | |- from_port - Provides a Controller based on a port connection. | +- from_socket_file - Provides a Controller based on a socket file connection. @@ -476,7 +478,7 @@ def with_default(yields = False): return decorator -def event_summary(event): +def event_description(event): """ Provides a description for Tor events. diff --git a/stem/settings.cfg b/stem/settings.cfg index a08a6db..3c8cec4 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -1,12 +1,9 @@ ################################################################################ # -# Information related to tor configuration options... +# Information related to tor configuration options and events... # # * manual.important Most commonly used configuration options. # * manual.summary Short summary describing the option. -# -# Tor and Nyx event descriptions... -# # * event.description Descriptions for the events. # ################################################################################ @@ -366,34 +363,36 @@ manual.summary.TestingLinkKeySlop Time before expiration that we replace our ed2 manual.summary.TestingAuthKeySlop Time before expiration that we replace our ed25519 authentication key manual.summary.TestingSigningKeySlop Time before expiration that we replace our ed25519 signing key -event.description.debug Tor debug logging event. -event.description.info Tor info logging event. -event.description.notice Tor notice logging event. -event.description.warn Tor warn logging event. -event.description.err Tor error logging event. +# Brief description of tor events + +event.description.debug Logging at the debug runlevel. This is low level, high volume information about tor's internals that generally isn't useful to users. +event.description.info Logging at the info runlevel. This is low level information of important internal processes. +event.description.notice Logging at the notice runlevel. This runlevel and above are shown to users by default, and includes general information the user should be aware of. +event.description.warn Logging at the warning runlevel. These are problems the user should be aware of. +event.description.err Logging at the error runlevel. These are critical issues that may prevent tor from working properly. event.description.nyx_debug Nyx debug logging event. event.description.nyx_info Nyx info logging event. event.description.nyx_notice Nyx notice logging event. event.description.nyx_warn Nyx warn logging event. event.description.nyx_error Nyx error logging event. -event.description.circ Indicates that a circuit has changed. -event.description.circ_minor Provides information about minor changes in our circuits. -event.description.stream Indicates that a stream has changed. -event.description.orconn Indicates a change in a relay connection. +event.description.circ Indicates that a circuit we've established through the tor network has been created, changed, or closed. +event.description.circ_minor Minor changes to our circuits, such as reuse of existing circuits for a different purpose. +event.description.stream Communication over a circuit we've established. For instance, Firefox making a connection through tor. +event.description.orconn Change in our connections as a relay. event.description.bw Event emitted every second with the bytes sent and received by tor. event.description.newdesc Indicates that a new descriptor is available. -event.description.addrmap Indicates a new address mapping. -event.description.authdir_newdescs Indicates that we just received new descriptors specific to directory authorities. +event.description.addrmap New address mapping for our DNS cache. +event.description.authdir_newdescs Indicates we just received a new descriptor. This is only used by directory authorities. event.description.descchanged Indicates that our descriptor has changed. -event.description.ns Event for when our copy of the consensus has changed. +event.description.ns Consensus information for an individual relay has changed. This could be due to receiving a new consensus or tor locally decides a relay is up or down. event.description.status_general Notification of a change in tor's state. -event.description.status_client Notification of a change in tor's state. -event.description.status_server Notification of a change in tor's state. -event.description.guard Indicates that our guard relays have changed. -event.description.stream_bw Event with the bytes sent and received by tor since the last such event on this stream. -event.description.clients_seen Periodic event on bridge relays that provide a summary of our users. -event.description.newconsensus Event for when we have a new consensus. +event.description.status_client Notification of a change in tor's state as a client (ie user). +event.description.status_server Notification of a change in tor's state as a relay. +event.description.guard Indicates that the set of relays we use for our initial connection into the tor network (guards) have changed. +event.description.stream_bw Event emitted every second with the bytes sent and received for a specific stream. +event.description.clients_seen Periodic summary of the countries we've seen users connect from. This is only used by bridge relays. +event.description.newconsensus Received a new hourly consensus of relays in the tor network. event.description.buildtimeout_set Indicates the timeout value for a circuit has changed. -event.description.signal Indicates that tor has received and acted upon a signal being sent to the process. -event.description.conf_changed Indicates that our configuration changed, either in a response to a SETCONF or RELOAD signal. +event.description.signal Indicates that tor has received and acted upon a signal being sent to its process. +event.description.conf_changed Indicates that our torrc configuration has changed. This could be in response to a SETCONF or RELOAD signal. diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index 1b61e4d..afde523 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -34,10 +34,10 @@ class TestControl(unittest.TestCase): with patch('stem.control.Controller.add_event_listener', Mock()): self.controller = Controller(socket) - def test_event_summary(self): - self.assertEqual('Tor debug logging event.', stem.control.event_summary('DEBUG')) - self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_summary('BW')) - self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_summary('bw')) + def test_event_description(self): + self.assertEqual('Tor debug logging event.', stem.control.event_description('DEBUG')) + self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_description('BW')) + self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_description('bw')) @patch('stem.control.Controller.get_info') def test_get_version(self, get_info_mock):

1 0

[stem/master] Drop nyx runlevels
by atagar＠torproject.org 22 May '16

22 May '16

commit 8c5174aec52ed59924e0c7af343ba1a1a3893d0d Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 20 10:23:05 2016 -0700 Drop nyx runlevels Stem shouldn't even know nyx exists. We're a general purpose controller library. Nyx will provide its own descriptions for these (maybe just reuse the tor descriptions, replacing 'tor' with 'nyx'). --- stem/settings.cfg | 5 ----- 1 file changed, 5 deletions(-) diff --git a/stem/settings.cfg b/stem/settings.cfg index 3c8cec4..48a1a41 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -370,11 +370,6 @@ event.description.info Logging at the info runlevel. This is low level informati event.description.notice Logging at the notice runlevel. This runlevel and above are shown to users by default, and includes general information the user should be aware of. event.description.warn Logging at the warning runlevel. These are problems the user should be aware of. event.description.err Logging at the error runlevel. These are critical issues that may prevent tor from working properly. -event.description.nyx_debug Nyx debug logging event. -event.description.nyx_info Nyx info logging event. -event.description.nyx_notice Nyx notice logging event. -event.description.nyx_warn Nyx warn logging event. -event.description.nyx_error Nyx error logging event. event.description.circ Indicates that a circuit we've established through the tor network has been created, changed, or closed. event.description.circ_minor Minor changes to our circuits, such as reuse of existing circuits for a different purpose. event.description.stream Communication over a circuit we've established. For instance, Firefox making a connection through tor.

1 0

[stem/master] Move event_summary() to control module
by atagar＠torproject.org 22 May '16

22 May '16

commit 5fff8a45d81d8edb5ec3dbff19df3125da88429d Author: Damian Johnson <atagar(a)torproject.org> Date: Fri May 20 08:32:23 2016 -0700 Move event_summary() to control module Gave this a bit more thought and I was wrong to suggest putting this in response/events.py. The response module is internal - we don't tell users it exists so we shouldn't put callable functions in there. The control module already includes an enum of all the event types so this actually isn't such a bad fit. --- stem/control.py | 12 ++++++++++++ stem/response/events.py | 12 ------------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/stem/control.py b/stem/control.py index 3243d1c..0ed7e8d 100644 --- a/stem/control.py +++ b/stem/control.py @@ -261,6 +261,7 @@ import stem.descriptor.reader import stem.descriptor.router_status_entry import stem.descriptor.server_descriptor import stem.exit_policy +import stem.manual import stem.response import stem.response.events import stem.socket @@ -475,6 +476,17 @@ def with_default(yields = False): return decorator +def event_summary(event): + """ + Provides a description for Tor events. + + :param str event: the event for which a description is needed + + :returns: str The event description + """ + return stem.manual._config().get('event.description.%s' % event.lower(), '') + + class BaseController(object): """ Controller for the tor process. This is a minimal base class for other diff --git a/stem/response/events.py b/stem/response/events.py index 50051c0..35cc98f 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -8,7 +8,6 @@ import time import stem import stem.control import stem.descriptor.router_status_entry -import stem.manual import stem.response import stem.version @@ -1322,17 +1321,6 @@ def _parse_cell_type_mapping(mapping): return results -def event_summary(event): - """ - Provides a description for Tor events. - - :param str event: the event for which a description is needed - - :returns: str The event description - """ - return stem.manual._config().get('event.description.%s' % event.lower(), '') - - EVENT_TYPE_TO_CLASS = { 'ADDRMAP': AddrMapEvent, 'AUTHDIR_NEWDESCS': AuthDirNewDescEvent,

1 0

[stem/master] Add and test for missing event types
by atagar＠torproject.org 22 May '16

22 May '16

commit 7476dfab9424c35e182fbab44920bb84a12b7470 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 21 18:18:16 2016 -0700 Add and test for missing event types We didn't quite cover all tor's events. Filling in the blanks and testing for this. Our integ tests check that our EventType enum is up to date. --- stem/control.py | 2 +- stem/settings.cfg | 8 ++++++++ test/unit/control/controller.py | 8 +++++++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/stem/control.py b/stem/control.py index a036144..621aaea 100644 --- a/stem/control.py +++ b/stem/control.py @@ -486,7 +486,7 @@ def event_description(event): :returns: str The event description """ - return stem.manual._config().get('event.description.%s' % event.lower(), '') + return stem.manual._config().get('event.description.%s' % event.lower(), None) class BaseController(object): diff --git a/stem/settings.cfg b/stem/settings.cfg index aafeafd..d08cc6e 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -375,12 +375,18 @@ event.description.addrmap New address mapping for our DNS cache. event.description.authdir_newdescs Indicates we just received a new descriptor. This is only used by directory authorities. event.description.buildtimeout_set Indicates the timeout value for a circuit has changed. event.description.bw Event emitted every second with the bytes sent and received by tor. +event.description.cell_stats Event emitted every second with the count of the number of cell types per circuit. event.description.circ Indicates that a circuit we've established through the tor network has been created, changed, or closed. +event.description.circ_bw Event emitted every second with the bytes sent and received on a per-circuit basis. event.description.circ_minor Minor changes to our circuits, such as reuse of existing circuits for a different purpose. event.description.clients_seen Periodic summary of the countries we've seen users connect from. This is only used by bridge relays. event.description.conf_changed Indicates that our torrc configuration has changed. This could be in response to a SETCONF or RELOAD signal. +event.description.conn_bw Event emitted every second with the byytes sent and received on a per-connection basis. event.description.descchanged Indicates that our descriptor has changed. event.description.guard Indicates that the set of relays we use for our initial connection into the tor network (guards) have changed. +event.description.hs_desc Received a hidden service descriptor that wasn't yet cached. +event.description.hs_desc_content Content of a hidden service descriptor we've fetched. +event.description.network_liveness Emitted when the network becomes reachable or unreachable. event.description.newconsensus Received a new hourly consensus of relays in the tor network. event.description.newdesc Indicates that a new descriptor is available. event.description.ns Consensus information for an individual relay has changed. This could be due to receiving a new consensus or tor locally decides a relay is up or down. @@ -391,4 +397,6 @@ event.description.status_general Notification of a change in tor's state. event.description.status_server Notification of a change in tor's state as a relay. event.description.stream Communication over a circuit we've established. For instance, Firefox making a connection through tor. event.description.stream_bw Event emitted every second with the bytes sent and received for a specific stream. +event.description.tb_empty Statistics for when token buckets are refilled. This is only used when TestingTorNetwork is set. +event.description.transport_launched Emitted when a pluggable transport is launched. diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index afde523..b9870ae 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -35,10 +35,16 @@ class TestControl(unittest.TestCase): self.controller = Controller(socket) def test_event_description(self): - self.assertEqual('Tor debug logging event.', stem.control.event_description('DEBUG')) + self.assertEqual("Logging at the debug runlevel. This is low level, high volume information about tor's internals that generally isn't useful to users.", stem.control.event_description('DEBUG')) self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_description('BW')) self.assertEqual('Event emitted every second with the bytes sent and received by tor.', stem.control.event_description('bw')) + def test_event_description_includes_all_events(self): + self.assertEqual(None, stem.control.event_description('NO_SUCH_EVENT')) + + for event in stem.control.EventType: + self.assertTrue(stem.control.event_description(event) is not None) + @patch('stem.control.Controller.get_info') def test_get_version(self, get_info_mock): """

1 0

[stem/master] Sort events alphabetically
by atagar＠torproject.org 22 May '16

22 May '16

commit db004cb32f97bd8a72035f270948ff2e9b430899 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 21 17:59:06 2016 -0700 Sort events alphabetically With the exception of the runlevels sorting the events to make them easier to find. --- stem/settings.cfg | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/stem/settings.cfg b/stem/settings.cfg index 48a1a41..aafeafd 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -370,24 +370,25 @@ event.description.info Logging at the info runlevel. This is low level informati event.description.notice Logging at the notice runlevel. This runlevel and above are shown to users by default, and includes general information the user should be aware of. event.description.warn Logging at the warning runlevel. These are problems the user should be aware of. event.description.err Logging at the error runlevel. These are critical issues that may prevent tor from working properly. -event.description.circ Indicates that a circuit we've established through the tor network has been created, changed, or closed. -event.description.circ_minor Minor changes to our circuits, such as reuse of existing circuits for a different purpose. -event.description.stream Communication over a circuit we've established. For instance, Firefox making a connection through tor. -event.description.orconn Change in our connections as a relay. -event.description.bw Event emitted every second with the bytes sent and received by tor. -event.description.newdesc Indicates that a new descriptor is available. + event.description.addrmap New address mapping for our DNS cache. event.description.authdir_newdescs Indicates we just received a new descriptor. This is only used by directory authorities. +event.description.buildtimeout_set Indicates the timeout value for a circuit has changed. +event.description.bw Event emitted every second with the bytes sent and received by tor. +event.description.circ Indicates that a circuit we've established through the tor network has been created, changed, or closed. +event.description.circ_minor Minor changes to our circuits, such as reuse of existing circuits for a different purpose. +event.description.clients_seen Periodic summary of the countries we've seen users connect from. This is only used by bridge relays. +event.description.conf_changed Indicates that our torrc configuration has changed. This could be in response to a SETCONF or RELOAD signal. event.description.descchanged Indicates that our descriptor has changed. +event.description.guard Indicates that the set of relays we use for our initial connection into the tor network (guards) have changed. +event.description.newconsensus Received a new hourly consensus of relays in the tor network. +event.description.newdesc Indicates that a new descriptor is available. event.description.ns Consensus information for an individual relay has changed. This could be due to receiving a new consensus or tor locally decides a relay is up or down. -event.description.status_general Notification of a change in tor's state. +event.description.orconn Change in our connections as a relay. +event.description.signal Indicates that tor has received and acted upon a signal being sent to its process. event.description.status_client Notification of a change in tor's state as a client (ie user). +event.description.status_general Notification of a change in tor's state. event.description.status_server Notification of a change in tor's state as a relay. -event.description.guard Indicates that the set of relays we use for our initial connection into the tor network (guards) have changed. +event.description.stream Communication over a circuit we've established. For instance, Firefox making a connection through tor. event.description.stream_bw Event emitted every second with the bytes sent and received for a specific stream. -event.description.clients_seen Periodic summary of the countries we've seen users connect from. This is only used by bridge relays. -event.description.newconsensus Received a new hourly consensus of relays in the tor network. -event.description.buildtimeout_set Indicates the timeout value for a circuit has changed. -event.description.signal Indicates that tor has received and acted upon a signal being sent to its process. -event.description.conf_changed Indicates that our torrc configuration has changed. This could be in response to a SETCONF or RELOAD signal.

1 0

[stem/master] Provide human-readable event descriptions
by atagar＠torproject.org 22 May '16

22 May '16

commit 7773234cbdd43e768babe6bb930303e4c13b74e3 Merge: b6b6568 c0af252 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 21 18:43:39 2016 -0700 Provide human-readable event descriptions Adding a new stem.control.event_description(event) function that can be used to get a human-friendly description of an event type. This is primarily for Nyx, but could be useful to others (similar to how we provide more human-readable manual information)... https://trac.torproject.org/projects/tor/ticket/19061 docs/change_log.rst | 1 + stem/control.py | 32 ++++++++++++++++++++++++++++++++ stem/manual.py | 2 +- stem/settings.cfg | 40 +++++++++++++++++++++++++++++++++++++++- test/unit/control/controller.py | 11 +++++++++++ 5 files changed, 84 insertions(+), 2 deletions(-)

1 0

[stem/master] Fetching event descriptions directly, rather than use manual.py
by atagar＠torproject.org 22 May '16

22 May '16

commit c0af25275f66e36c05f721167949dd63ef4ebed3 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 21 18:37:33 2016 -0700 Fetching event descriptions directly, rather than use manual.py Using the manual's _config() certainly did the trick, but kinda a hack. Populating our own cache of these. This now omits events from _config() so its cache is a little smaller. --- docs/change_log.rst | 1 + stem/control.py | 24 +++++++++++++++++++++--- stem/manual.py | 2 +- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index b443c69..ecfc49a 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -49,6 +49,7 @@ The following are only available within Stem's `git repository * :func:`~stem.connection.connect` and :func:`~stem.control.Controller.from_port` now connect to both port 9051 (relay's default) and 9151 (Tor Browser's default) (:trac:`16075`) * :class:`~stem.exit_policy.ExitPolicy` support for *accept6/reject6* and *\*4/6* wildcards (:trac:`16053`) * Added `support for NETWORK_LIVENESS events <api/response.html#stem.response.events.NetworkLivenessEvent>`_ (:spec:`44aac63`) + * Added :func:`~stem.control.event_description` for getting human-friendly descriptions of tor events (:trac:`19061`) * Added :func:`~stem.control.Controller.reconnect` to the :class:`~stem.control.Controller` * Added :func:`~stem.control.Controller.is_set` to the :class:`~stem.control.Controller` * Added :func:`~stem.control.Controller.is_user_traffic_allowed` to the :class:`~stem.control.Controller` diff --git a/stem/control.py b/stem/control.py index 621aaea..f1eb274 100644 --- a/stem/control.py +++ b/stem/control.py @@ -263,10 +263,10 @@ import stem.descriptor.reader import stem.descriptor.router_status_entry import stem.descriptor.server_descriptor import stem.exit_policy -import stem.manual import stem.response import stem.response.events import stem.socket +import stem.util.conf import stem.util.connection import stem.util.enum import stem.util.str_tools @@ -378,12 +378,15 @@ UNCACHEABLE_GETCONF_PARAMS = ( # number of sequential attempts before we decide that the Tor geoip database # is unavailable + GEOIP_FAILURE_THRESHOLD = 5 SERVER_DESCRIPTORS_UNSUPPORTED = "Tor is currently not configured to retrieve \ server descriptors. As of Tor version 0.2.3.25 it downloads microdescriptors \ instead unless you set 'UseMicrodescriptors 0' in your torrc." +EVENT_DESCRIPTIONS = None + class AccountingStats(collections.namedtuple('AccountingStats', ['retrieved', 'status', 'interval_end', 'time_until_reset', 'read_bytes', 'read_bytes_left', 'read_limit', 'written_bytes', 'write_bytes_left', 'write_limit'])): """ @@ -484,9 +487,24 @@ def event_description(event): :param str event: the event for which a description is needed - :returns: str The event description + :returns: str The event description or **None** if this is an event name we + don't have a description for """ - return stem.manual._config().get('event.description.%s' % event.lower(), None) + + global EVENT_DESCRIPTIONS + + if EVENT_DESCRIPTIONS is None: + config = stem.util.conf.Config() + config_path = os.path.join(os.path.dirname(__file__), 'settings.cfg') + + try: + config.load(config_path) + EVENT_DESCRIPTIONS = dict([(key.lower()[18:], config.get_value(key)) for key in config.keys() if key.startswith('event.description.')]) + except Exception as exc: + log.warn("BUG: stem failed to load its internal manual information from '%s': %s" % (config_path, exc)) + return None + + return EVENT_DESCRIPTIONS.get(event.lower()) class BaseController(object): diff --git a/stem/manual.py b/stem/manual.py index be7b224..1e2a5e1 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -141,7 +141,7 @@ def _config(lowercase = True): try: config.load(config_path) - config_dict = dict([(key.lower() if lowercase else key, config.get_value(key)) for key in config.keys()]) + config_dict = dict([(key.lower() if lowercase else key, config.get_value(key)) for key in config.keys() if key.startswith('manual.summary.')]) config_dict['manual.important'] = [name.lower() if lowercase else name for name in config.get_value('manual.important', [], multiple = True)] return config_dict except Exception as exc:

1 0