April 2014 - tor-commits - lists.torproject.org

[bridgedb/develop] Simplify test_EmailServer.EmailResponseTests assertion checks.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 1e9c46fc4b238085141fb50e98183aa64e90db26 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 02:48:46 2014 +0000 Simplify test_EmailServer.EmailResponseTests assertion checks. --- lib/bridgedb/test/test_EmailServer.py | 64 +++++++++++++-------------------- 1 file changed, 24 insertions(+), 40 deletions(-) diff --git a/lib/bridgedb/test/test_EmailServer.py b/lib/bridgedb/test/test_EmailServer.py index 9e5db06..8087247 100644 --- a/lib/bridgedb/test/test_EmailServer.py +++ b/lib/bridgedb/test/test_EmailServer.py @@ -175,6 +175,20 @@ class EmailResponseTests(unittest.TestCase): "get bridges"] self.ctx = _createMailContext() + def _isTwoTupleOfNone(self, reply): + """Check that a return value is ``(None, None)``.""" + self.assertIsInstance(reply, tuple) + self.assertEqual(len(reply), 2) + self.assertEqual(reply[0], None) + self.assertEqual(reply[1], None) + + def _isTwoTupleOfAddrAndClass(self, reply, address="testing(a)example.com", + klass=io.StringIO): + self.assertIsInstance(reply, tuple) + self.assertEqual(len(reply), 2) + self.assertEqual(reply[0], address) + self.assertIsInstance(reply[1], klass) + def test_getMailResponse_noFrom(self): """A received email without a "From:" or "Sender:" header shouldn't receive a response. @@ -182,46 +196,31 @@ class EmailResponseTests(unittest.TestCase): lines = self.lines lines[0] = "" ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_badAddress(self): lines = copy.copy(self.lines) lines[0] = self.lines[0] % ("testing*.?\"", "example") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_anotherBadAddress(self): lines = copy.copy(self.lines) lines[0] = "From: Mallory %s(a)%s.com" % ("<>>", "example") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_invalidDomain(self): lines = copy.copy(self.lines) lines[0] = self.lines[0] % ("testing", "exa#mple") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_anotherInvalidDomain(self): lines = copy.copy(self.lines) lines[0] = self.lines[0] % ("testing", "exam+ple") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_DKIM_badDKIMheader(self): """An email with an appended 'X-DKIM-Authentication-Result:' header should not @@ -231,20 +230,14 @@ class EmailResponseTests(unittest.TestCase): lines[0] = self.lines[0] % ("testing", "gmail") lines.append("X-DKIM-Authentication-Result: ") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], None) - self.assertEqual(ret[1], None) + self._isTwoTupleOfNone(ret) def test_getMailResponse_DKIM(self): lines = copy.copy(self.lines) lines[0] = self.lines[0] % ("testing", "example") lines.append("X-DKIM-Authentication-Result: ") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], "testing(a)example.com") - self.assertIsInstance(ret[1], io.BytesIO) + self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() self.assertNotEqual(mail.find("no bridges currently"), -1) @@ -254,10 +247,7 @@ class EmailResponseTests(unittest.TestCase): lines[0] = self.lines[0] % ("testing", "example") lines.append("transport obfs") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], "testing(a)example.com") - self.assertIsInstance(ret[1], io.BytesIO) + self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() self.assertNotEqual(mail.find("no bridges currently"), -1) @@ -269,10 +259,7 @@ class EmailResponseTests(unittest.TestCase): lines.append("transport obfs") lines.append("unblocked webz") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], "testing(a)example.com") - self.assertIsInstance(ret[1], io.BytesIO) + self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() self.assertNotEqual(mail.find("no bridges currently"), -1) @@ -285,10 +272,7 @@ class EmailResponseTests(unittest.TestCase): lines.append("unblocked webz") lines.append("ipv6") ret = EmailServer.getMailResponse(lines, self.ctx) - self.assertIsInstance(ret, tuple) - self.assertEqual(len(ret), 2) - self.assertEqual(ret[0], "testing(a)example.com") - self.assertIsInstance(ret[1], io.BytesIO) + self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() self.assertNotEqual(mail.find("no bridges currently"), -1)

1 0

[bridgedb/develop] PEP8 whitespace fixes in EmailServer.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 7cd85e71440a432a0a9963904f535944c57ebde0 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 03:34:11 2014 +0000 PEP8 whitespace fixes in EmailServer. --- lib/bridgedb/EmailServer.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/lib/bridgedb/EmailServer.py b/lib/bridgedb/EmailServer.py index 65a3ccd..a645dbc 100644 --- a/lib/bridgedb/EmailServer.py +++ b/lib/bridgedb/EmailServer.py @@ -201,17 +201,14 @@ def getMailResponse(lines, ctx): except Dist.TooSoonEmail as err: logging.info("Got a mail too frequently; warning '%s': %s." % (clientAddr, err)) - # MAX_EMAIL_RATE is in seconds, convert to hours body = buildSpamWarningTemplate(t) % (Dist.MAX_EMAIL_RATE / 3600) return composeEmail(ctx.fromAddr, clientAddr, subject, body, msgID, - gpgContext=ctx.gpgContext) - + gpgContext=ctx.gpgContext) except Dist.IgnoreEmail as err: logging.info("Got a mail too frequently; ignoring '%s': %s." % (clientAddr, err)) return None, None - except BadEmail as err: logging.info("Got a mail from a bad email address '%s': %s." % (clientAddr, err))

1 0

[bridgedb/develop] Reorder transport requests in unittests.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 82547638ea0f6dbe0839cb1e2743c7eac2499795 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 03:30:50 2014 +0000 Reorder transport requests in unittests. BridgeDB only pays attention to the last transport request it received in an email. --- lib/bridgedb/test/test_EmailServer.py | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/lib/bridgedb/test/test_EmailServer.py b/lib/bridgedb/test/test_EmailServer.py index bc7e998..6f2adae 100644 --- a/lib/bridgedb/test/test_EmailServer.py +++ b/lib/bridgedb/test/test_EmailServer.py @@ -169,7 +169,7 @@ class EmailResponseTests(unittest.TestCase): """Create fake email, distributor, and associated context data.""" # TODO: Add headers if we start validating them self.lines = ["From: %s(a)%s.com", - "To: bridges(a)example.net", + "To: bridges@localhost", "Subject: testing", "", "get bridges"] @@ -182,7 +182,7 @@ class EmailResponseTests(unittest.TestCase): self.assertEqual(reply[0], None) self.assertEqual(reply[1], None) - def _isTwoTupleOfAddrAndClass(self, reply, address="testing(a)example.com", + def _isTwoTupleOfAddrAndClass(self, reply, address="testing@localhost", klass=io.StringIO): self.assertIsInstance(reply, tuple) self.assertEqual(len(reply), 2) @@ -239,30 +239,30 @@ class EmailResponseTests(unittest.TestCase): def test_getMailResponse_DKIM(self): """An email with a good DKIM header should be responded to.""" lines = copy.copy(self.lines) - lines[0] = self.lines[0] % ("testing", "example") - lines.append("X-DKIM-Authentication-Result: ") + lines[0] = self.lines[0] % ("testing", "localhost") + lines.insert(3, "X-DKIM-Authentication-Result: ") ret = EmailServer.getMailResponse(lines, self.ctx) self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() - self.assertNotEqual(mail.find("no bridges currently"), -1) + self.assertEqual(mail.find("no bridges currently"), -1) def test_getMailResponse_bridges_obfs3(self): """A request for 'transport obfs3' should receive a response.""" lines = copy.copy(self.lines) - lines[0] = self.lines[0] % ("testing", "example") - lines.append("transport obfs") + lines[0] = self.lines[0] % ("testing", "localhost") + lines[4] = "transport obfs3" ret = EmailServer.getMailResponse(lines, self.ctx) self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() - self.assertNotEqual(mail.find("no bridges currently"), -1) + self.assertEqual(mail.find("no bridges currently"), -1) def test_getMailResponse_bridges_obfsobfswebz(self): """We should only pay attention to the *last* in a crazy request.""" lines = copy.copy(self.lines) - lines[0] = self.lines[0] % ("testing", "example") - lines.append("transport obfs") - lines.append("transport obfs") - lines.append("unblocked webz") + lines[0] = self.lines[0] % ("testing", "localhost") + lines[4] = "unblocked webz" + lines.append("transport obfs2") + lines.append("transport obfs3") ret = EmailServer.getMailResponse(lines, self.ctx) self._isTwoTupleOfAddrAndClass(ret) mail = ret[1].getvalue() @@ -271,9 +271,8 @@ class EmailResponseTests(unittest.TestCase): def test_getMailResponse_bridges_obfsobfswebzipv6(self): """We should *still* only pay attention to the *last* request.""" lines = copy.copy(self.lines) - lines[0] = self.lines[0] % ("testing", "example") - lines.append("transport obfs") - lines.append("transport obfs") + lines[0] = self.lines[0] % ("testing", "localhost") + lines[4] = "transport obfs3" lines.append("unblocked webz") lines.append("ipv6") ret = EmailServer.getMailResponse(lines, self.ctx)

1 0

[bridgedb/develop] Merge branch 'fix/11522-exc-in-email-dist' into develop
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 39e3cf66a2324e262ae1fc617f4f2d0e79c0bf49 Merge: 63c32b5 f6f1bd8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 04:21:05 2014 +0000 Merge branch 'fix/11522-exc-in-email-dist' into develop Conflicts: lib/bridgedb/EmailServer.py lib/bridgedb/Dist.py | 117 ++----------- lib/bridgedb/EmailServer.py | 293 ++++++++++++++------------------- lib/bridgedb/Tests.py | 9 +- lib/bridgedb/crypto.py | 179 ++++++++++++++++++++ lib/bridgedb/parse/addr.py | 171 ++++++++++++++++++- lib/bridgedb/test/test_EmailServer.py | 278 ++++++++++++++++++++----------- 6 files changed, 673 insertions(+), 374 deletions(-) diff --cc lib/bridgedb/EmailServer.py index c58ec53,022dd41..a1980d1 --- a/lib/bridgedb/EmailServer.py +++ b/lib/bridgedb/EmailServer.py @@@ -29,28 -28,19 +28,19 @@@ from zope.interface import implement from bridgedb import Dist from bridgedb import I18n from bridgedb import safelog +from bridgedb import translations + from bridgedb.crypto import getGPGContext + from bridgedb.crypto import gpgSignMessage from bridgedb.Filters import filterBridgesByIP6 from bridgedb.Filters import filterBridgesByIP4 from bridgedb.Filters import filterBridgesByTransport from bridgedb.Filters import filterBridgesByNotBlockedIn + from bridgedb.parse import addr + from bridgedb.parse.addr import BadEmail + from bridgedb.parse.addr import UnsupportedDomain + from bridgedb.parse.addr import canonicalizeEmailDomain - class MailFile: - """A file-like object used to hand rfc822.Message a list of lines - as though it were reading them from a file.""" - def __init__(self, lines): - self.lines = lines - self.idx = 0 - def readline(self): - try : - line = self.lines[self.idx] - self.idx += 1 - return line - except IndexError: - return "" -- def getBridgeDBEmailAddrFromList(ctx, address_list): """Loop through a list of (full name, email address) pairs and look up our mail address. If our address isn't found (which can't happen), return @@@ -75,46 -65,67 +65,67 @@@ def getMailResponse(lines, ctx) will receive the response, and a readable filelike object containing the response. Return None,None if we shouldn't answer. """ + raw = io.StringIO() + raw.writelines([unicode('{0}\n'.format(line)) for line in lines]) + raw.seek(0) + + msg = smtp.rfc822.Message(raw) # Extract data from the headers. - msg = rfc822.Message(MailFile(lines)) - subject = msg.getheader("Subject", None) - if not subject: subject = "[no subject]" - clientFromAddr = msg.getaddr("From") - clientSenderAddr = msg.getaddr("Sender") - # RFC822 requires at least one 'To' address - clientToList = msg.getaddrlist("To") - clientToaddr = getBridgeDBEmailAddrFromList(ctx, clientToList) msgID = msg.getheader("Message-ID", None) - if clientSenderAddr and clientSenderAddr[1]: - clientAddr = clientSenderAddr[1] - elif clientFromAddr and clientFromAddr[1]: - clientAddr = clientFromAddr[1] - else: - logging.info("No From or Sender header on incoming mail.") - return None,None + subject = msg.getheader("Subject", None) or "[no subject]" - # Look up the locale part in the 'To:' address, if there is one and get - # the appropriate Translation object - lang = translations.getLocaleFromPlusAddr(clientToaddr) - t = translations.installTranslations(lang) + fromHeader = msg.getaddr("From") + senderHeader = msg.getaddr("Sender") + clientAddrHeader = None try: - _, addrdomain = Dist.extractAddrSpec(clientAddr.lower()) - except BadEmail: - logging.info("Ignoring bad address on incoming email.") + clientAddrHeader = fromHeader[1] + except (IndexError, TypeError, AttributeError): + pass + + if not clientAddrHeader: + logging.warn("No From header on incoming mail.") + try: + clientAddrHeader = senderHeader[1] + except (IndexError, TypeError, AttributeError): + pass + + if not clientAddrHeader: + logging.warn("No Sender header on incoming mail.") return None, None - if not addrdomain: - logging.info("Couldn't parse domain from %r" % clientAddr) + try: + clientAddr = addr.normalizeEmail(clientAddrHeader, + ctx.cfg.EMAIL_DOMAIN_MAP, + ctx.cfg.EMAIL_DOMAIN_RULES) + except (UnsupportedDomain, BadEmail) as error: + logging.warn(error) + return None, None - if addrdomain and ctx.cfg.EMAIL_DOMAIN_MAP: - addrdomain = ctx.cfg.EMAIL_DOMAIN_MAP.get(addrdomain, addrdomain) + # RFC822 requires at least one 'To' address + clientToList = msg.getaddrlist("To") + clientToAddr = getBridgeDBEmailAddrFromList(ctx, clientToList) + + # Look up the locale part in the 'To:' address, if there is one and get + # the appropriate Translation object - lang = getLocaleFromPlusAddr(clientToAddr) - t = I18n.getLang(lang) ++ lang = translations.getLocaleFromPlusAddr(clientToAddr) ++ t = translations.installTranslations(lang) - if addrdomain not in ctx.cfg.EMAIL_DOMAINS: - logging.warn("Unrecognized email domain %r", addrdomain) + canon = ctx.cfg.EMAIL_DOMAIN_MAP + for domain, rule in ctx.cfg.EMAIL_DOMAIN_RULES.items(): + if domain not in canon.keys(): + canon[domain] = domain + for domain in ctx.cfg.EMAIL_DOMAINS: + canon[domain] = domain + + try: + _, clientDomain = addr.extractEmailAddress(clientAddr.lower()) + canonical = canonicalizeEmailDomain(clientDomain, canon) + except (UnsupportedDomain, BadEmail) as error: + logging.warn(error) return None, None - rules = ctx.cfg.EMAIL_DOMAIN_RULES.get(addrdomain, []) + rules = ctx.cfg.EMAIL_DOMAIN_RULES.get(canonical, []) if 'dkim' in rules: # getheader() returns the last of a given kind of header; we want @@@ -287,7 -297,71 +297,46 @@@ def replyToMail(lines, ctx) reactor.connectTCP(ctx.smtpServer, ctx.smtpPort, factory) return d -def getLocaleFromPlusAddr(address): - """See whether the user sent his email to a 'plus' address, for - instance to bridgedb+fa@tpo. Plus addresses are the current - mechanism to set the reply language - """ - replyLocale = "en" - r = '.*(<)?(\w+\+(\w+)@\w+(?:\.\w+)+)(?(1)>)' - match = re.match(r, address) - if match: - replyLocale = match.group(3) - - return replyLocale - -def getLocaleFromRequest(request): - # See if we did get a request for a certain locale, otherwise fall back - # to 'en': - # Try evaluating the path /foo first, then check if we got a ?lang=foo - default_lang = lang = "en" - if len(request.path) > 1: - lang = request.path[1:] - if lang == default_lang: - lang = request.args.get("lang", [default_lang]) - lang = lang[0] - return I18n.getLang(lang) - + def composeEmail(fromAddr, clientAddr, subject, body, + msgID=None, gpgContext=None): + + if not subject.startswith("Re:"): + subject = "Re: %s" % subject + + msg = smtp.rfc822.Message(io.StringIO()) + msg.setdefault("From", fromAddr) + msg.setdefault("To", clientAddr) + msg.setdefault("Message-ID", smtp.messageid()) + msg.setdefault("Subject", subject) + if msgID: + msg.setdefault("In-Reply-To", msgID) + msg.setdefault("Date", smtp.rfc822date()) + msg.setdefault('Content-Type', 'text/plain; charset="utf-8"') + headers = [': '.join(m) for m in msg.items()] + + mail = io.BytesIO() + mail.writelines(buffer("\r\n".join(headers))) + mail.writelines(buffer("\r\n")) + mail.writelines(buffer("\r\n")) + + if not gpgContext: + mail.write(buffer(body)) + else: + signature, siglist = gpgSignMessage(gpgContext, body) + if signature: + mail.writelines(buffer(signature)) + mail.seek(0) + + # Only log the email text (including all headers) if SAFE_LOGGING is + # disabled: + if not safelog.safe_logging: + logging.debug("Email contents:\n\n%s" % mail.read()) + mail.seek(0) + else: + logging.debug("Email text for %r created." % clientAddr) + + return clientAddr, mail + class MailContext(object): """Helper object that holds information used by email subsystem."""

1 0

[bridgedb/develop] Merge branch 'fix/7550-9678-interactive-translations' into develop
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 63c32b501738e420e05a7617e1bb08bff489af37 Merge: 09a49cd a6edfae Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 04:10:02 2014 +0000 Merge branch 'fix/7550-9678-interactive-translations' into develop lib/bridgedb/EmailServer.py | 29 +------- lib/bridgedb/HTTPServer.py | 94 ++---------------------- lib/bridgedb/test/test_translations.py | 78 ++++++++++++++++++++ lib/bridgedb/translations.py | 122 ++++++++++++++++++++++++++++++++ 4 files changed, 210 insertions(+), 113 deletions(-)

1 0

[bridgedb/develop] Update CHANGELOG with entries for 0.1.7.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 45d6effabd43fbd0f99dd747ce768441ea2c3d70 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Apr 17 05:04:14 2014 +0000 Update CHANGELOG with entries for 0.1.7. --- CHANGELOG | 62 +++++++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 50 insertions(+), 12 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 22b5baa..1db9dc5 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,19 +1,57 @@ Changes in version 0.1.7 - - * FIXES #5232 Perform long running and blocking transactions - in background threads. Primarily this moves bridge - descriptor reparsing into another thread and - significantly increased the availability of BridgeDB, - as a result. - * FIXES #11370 We were using an old (and deprecated) module when - we created our email responses. Now we use the newer - version. This should only affect internal functionality - And should not result in any noticable user-visible changes. + * FIXES #5232 Perform long running and blocking transactions in + background threads. Primarily this moves bridge descriptor + reparsing into another thread, which significantly increases + the availability of BridgeDB. + * FIXES #9119 BridgeDB's logger now automatically sanitises all email + and IP addresses when the SAFELOGGING config option is enabled. + * FIXES #9875 BridgeDB logger now has 100% unittest coverage. + * FIXES #10803 Vidalia is no longer mentioned on + https://bridges.torproject.org, and instead there are new + instructions on how to enter bridges into TBB>=3.5 (with + TorLauncher). + * FIXES #11346 The web interface now has a homepage link. By clicking + "BridgeDB" in the upper left corner, users can go back to the + start of TBB downloading and bridge selection instructions at + https://bridges.torproject.org. + * FIXES #11370 We were using an old (and deprecated) module when we + created our email responses. Now we use the newer version. * FIXES #11377 CAPTCHAs on BridgeDB's HTTPS interface are now - case-insensitive. Patch thanks to Kostas Jakeliunas. + case-insensitive. + Thanks to Kostas Jakeliunas for the patch. + * FIXES #11522 fixes several issues with encodings and exception + handling in the email distributor. And includes the following general changes: - * BUMPS leekspin version to 0.1.3 - + * NEW interface design for https://bridges.torproject.org, including + updated CSS stylesheets, fonts, and HTML templates. In + particular, the https://bridges.torproject.org/options page has + been redesigned completely. + Thanks to Xengi for providing a modified design of the "roots" + Tor Project logo, which is used to link to + https://www.torproject.org. + * CHANGES the TBB download link on the main web interface page to link + to the new TBB-3.6.x-beta bundles, which include patches by + David Fifield to unify TBB and PTTBB into one browser, so that + Pluggable Transports (PTs) are only enabled when the user + includes a bridge line which uses that PT. + * FIXES plaintext responses on https://bridges.torproject.org, + these can be requested by using the 'format' HTTP parameter, + like so: https://bridges.torproject.org/bridges?format=plain + * FIXES the logging of all lines of (including headers!) of incoming + emails. + * FIXES logfile rotation so that the files are only reable/writable + by the running process owner, and no other user. + * CHANGES the data format used for encrypted-then-HMACed CAPTCHAs + to assume that the HMAC is the first 20 bytes. Before we + assumed that the HMAC was separated from the encrypted data + with a ';' character, which causes intermittent issues with + some encoding and CAPTCHA solution values. + * REFACTORS some of the translations handling code, so that soon emails + will be translated (see #7550), and + https://bridges.torproject.org should have a "Select Language" + button (see #9678). + * BUMPS leekspin version to 0.1.3. Changes in version 0.1.6 - 2014-03-26 BridgeDB 0.1.6 includes fixes for the following bugs:

1 0

[bridgedb/develop] Fix issue with transport URL params in HTTPServer unittests.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 5e37dc53df4704c9b4ab0f3943159a5198f0c515 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 16 19:26:19 2014 +0000 Fix issue with transport URL params in HTTPServer unittests. Also fixes several PEP8 whitespace issues in test_HTTPServer.py. --- lib/bridgedb/test/test_HTTPServer.py | 83 +++++++++++++++++++++------------- 1 file changed, 52 insertions(+), 31 deletions(-) diff --git a/lib/bridgedb/test/test_HTTPServer.py b/lib/bridgedb/test/test_HTTPServer.py index 111adc1..52c2fb7 100644 --- a/lib/bridgedb/test/test_HTTPServer.py +++ b/lib/bridgedb/test/test_HTTPServer.py @@ -178,8 +178,8 @@ class GimpCaptchaProtectedResourceTests(unittest.TestCase): self.request.method = b'POST' self.request.addArg('captcha_challenge_field', expectedChallenge) - self.request.addArg('captcha_response_field', expectedResponse) - + self.request.addArg('captcha_response_field', expectedResponse) + response = self.captchaResource.extractClientSolution(self.request) (challenge, response) = response self.assertEqual(challenge, expectedChallenge) @@ -192,8 +192,8 @@ class GimpCaptchaProtectedResourceTests(unittest.TestCase): self.request.method = b'POST' self.request.addArg('captcha_challenge_field', expectedChallenge) - self.request.addArg('captcha_response_field', expectedResponse) - + self.request.addArg('captcha_response_field', expectedResponse) + valid = self.captchaResource.checkSolution(self.request) self.assertFalse(valid) @@ -238,7 +238,7 @@ class GimpCaptchaProtectedResourceTests(unittest.TestCase): """ self.request.method = b'POST' self.request.addArg('captcha_challenge_field', '') - self.request.addArg('captcha_response_field', '') + self.request.addArg('captcha_response_field', '') page = self.captchaResource.render_POST(self.request) self.assertEqual(BeautifulSoup(page).find('meta')['http-equiv'], @@ -253,7 +253,7 @@ class GimpCaptchaProtectedResourceTests(unittest.TestCase): self.request.method = b'POST' self.request.addArg('captcha_challenge_field', expectedChallenge) - self.request.addArg('captcha_response_field', expectedResponse) + self.request.addArg('captcha_response_field', expectedResponse) page = self.captchaResource.render_POST(self.request) self.assertEqual(BeautifulSoup(page).find('meta')['http-equiv'], @@ -357,8 +357,8 @@ class ReCaptchaProtectedResourceTests(unittest.TestCase): """ self.request.method = b'POST' self.request.addArg('captcha_challenge_field', '') - self.request.addArg('captcha_response_field', '') - + self.request.addArg('captcha_response_field', '') + self.assertEqual((False, self.request), self.successResultOf( self.captchaResource.checkSolution(self.request))) @@ -398,7 +398,7 @@ class ReCaptchaProtectedResourceTests(unittest.TestCase): """ self.request.method = b'POST' self.request.addArg('captcha_challenge_field', '') - self.request.addArg('captcha_response_field', '') + self.request.addArg('captcha_response_field', '') page = self.captchaResource.render_POST(self.request) self.assertEqual(page, HTTPServer.server.NOT_DONE_YET) @@ -412,7 +412,7 @@ class ReCaptchaProtectedResourceTests(unittest.TestCase): self.request.method = b'POST' self.request.addArg('captcha_challenge_field', expectedChallenge) - self.request.addArg('captcha_response_field', expectedResponse) + self.request.addArg('captcha_response_field', expectedResponse) page = self.captchaResource.render_POST(self.request) self.assertEqual(page, HTTPServer.server.NOT_DONE_YET) @@ -580,34 +580,51 @@ class WebResourceBridgesTests(unittest.TestCase): page = self.bridgesResource.render(request) self.bridgesResource.useForwardedHeader = False # Reset it - self.assertSubstring("To enter bridges into", page) + + # The response should explain how to use the bridge lines: + self.assertTrue("To enter bridges into Tor Browser" in str(page)) def test_render_GET_RTLlang(self): - """Test rendering a request for obfs3 bridges in Arabic.""" - request = DummyRequest(["bridges?transport=obfs3"]) + """Test rendering a request for plain bridges in Arabic.""" + request = DummyRequest([b"bridges?transport=obfs3"]) + request.method = b'GET' + request.getClientIP = lambda: '3.3.3.3' + # For some strange reason, the 'Accept-Language' value *should not* be + # a list, unlike all the other headers and args… + request.headers.update({'accept-language': 'ar,en,en_US,'}) + + page = self.bridgesResource.render(request) + self.assertSubstring("direction: rtl", page) + self.assertSubstring( + "إذا لم يعمل تور بنجاح معك، يجب عليك ارسال بريد إلكتروني إلي", page) + + for bridgeLine in self.parseBridgesFromHTMLPage(page): + # Check that each bridge line had the expected number of fields: + bridgeLine = bridgeLine.split(' ') + self.assertEqual(len(bridgeLine), 2) + + def test_render_GET_RTLlang_obfs3(self): + """Test rendering a request for obfs3 bridges in Farsi.""" + request = DummyRequest([b"bridges?transport=obfs3"]) request.method = b'GET' request.getClientIP = lambda: '3.3.3.3' - request.headers.update({'accept-language': 'ar'}) + request.headers.update({'accept-language': 'fa,en,en_US,'}) # We actually have to set the request args manually when using a # DummyRequest: - request.args.update({'transport': 'obfs3'}) + request.args.update({'transport': ['obfs3']}) page = self.bridgesResource.render(request) self.assertSubstring("direction: rtl", page) self.assertSubstring( - "إذا لم يعمل تور بنجاح معك، يجب عليك ارسال بريد إلكتروني إلي", page) + # "I need an alternative way to get bridges!" + "به یک راه دیگر برای دریافت پل‌ها احتیاج دارم!", + page) for bridgeLine in self.parseBridgesFromHTMLPage(page): # Check that each bridge line had the expected number of fields: bridgeLine = bridgeLine.split(' ') self.assertEqual(len(bridgeLine), 3) - - print(""" - FIXME: The first field should be the transport method: - DummyBridge.getConfigLine() receives transport='o', not 'obfs3'. - What the hell? - """) - #self.assertEqual(bridgeLine[0], 'obfs3') + self.assertEqual(bridgeLine[0], 'obfs3') # Check that the IP and port seem okay: ip, port = bridgeLine[1].rsplit(':') @@ -616,24 +633,28 @@ class WebResourceBridgesTests(unittest.TestCase): self.assertGreater(int(port), 0) self.assertLessEqual(int(port), 65535) + def test_renderAnswer_textplain(self): """If the request format specifies 'plain', we should return content with mimetype 'text/plain'. """ request = DummyRequest([self.pagename]) - request.args.update({'format': 'plain'}) + request.args.update({'format': ['plain']}) request.getClientIP = lambda: '4.4.4.4' request.method = b'GET' page = self.bridgesResource.render(request) + self.assertTrue("html" not in str(page)) - print(""" - FIXME: The result page should have a mimetype of 'text/plain', and yet - it's still HTML. - """) - #self.assertNotSubstring("html", page) + # We just need to strip and split it because it looks like: + # + # 94.235.85.233:9492 0d9d0547c3471cddc473f7288a6abfb54562dc06 + # 255.225.204.145:9511 1fb89d618b3a12afe3529fd072127ea08fb50466 + # + # (Yes, there are two leading spaces at the beginning of each line) + # + bridgeLines = [line.strip() for line in page.strip().split('\n')] - bridgeLines = self.parseBridgesFromHTMLPage(page) for bridgeLine in bridgeLines: bridgeLine = bridgeLine.split(' ') self.assertEqual(len(bridgeLine), 2) @@ -665,7 +686,7 @@ class WebResourceOptionsTests(unittest.TestCase): request.headers.update({'accept-language': 'he'}) # We actually have to set the request args manually when using a # DummyRequest: - request.args.update({'transport': 'obfs2'}) + request.args.update({'transport': ['obfs2']}) page = self.optionsResource.render(request) self.assertSubstring("direction: rtl", page)

1 0

[bridgedb/develop] PEP8; change geoipdb → GEOIP_DBFILE.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit 1115b5ab2b41780761c9f4fa52bb0dbefd41db45 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 16 19:40:47 2014 +0000 PEP8; change geoipdb → GEOIP_DBFILE. --- lib/bridgedb/HTTPServer.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 1d4cdf9..9176f6a 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -45,6 +45,7 @@ from bridgedb.safelog import logSafely TEMPLATE_DIR = os.path.join(os.path.dirname(__file__),'templates') +GEOIP_DBFILE = '/usr/share/GeoIP/GeoIP.dat' rtl_langs = ('ar', 'he', 'fa', 'gu_IN', 'ku') # Setting `filesystem_checks` to False is recommended for production servers, @@ -58,22 +59,19 @@ lookup = TemplateLookup(directories=[TEMPLATE_DIR], output_encoding='utf-8', filesystem_checks=False, collection_size=500) - - -_geoipdb = '/usr/share/GeoIP/GeoIP.dat' logging.debug("Set template root to %s" % TEMPLATE_DIR) try: # Make sure we have the database before trying to import the module: - if not os.path.isfile(_geoipdb): # pragma: no cover + if not os.path.isfile(GEOIP_DBFILE): # pragma: no cover raise EnvironmentError("Could not find %r. On Debian-based systems, "\ "please install the geoip-database package." - % _geoipdb) + % GEOIP_DBFILE) # This is a "pure" python version which interacts with the Maxmind GeoIP # API (version 1). It requires, in Debian, the libgeoip-dev and # geoip-database packages. import pygeoip - geoip = pygeoip.GeoIP(_geoipdb, flags=pygeoip.MEMORY_CACHE) + geoip = pygeoip.GeoIP(GEOIP_DBFILE, flags=pygeoip.MEMORY_CACHE) logging.info("GeoIP database loaded") except Exception as err: # pragma: no cover logging.warn("Error while loading geoip module: %r" % err)

1 0

[bridgedb/develop] Add unittests for new bridgedb.translations module.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit a6edfaeb6fc8036c60d9c20bf871795cba198337 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 16 19:19:49 2014 +0000 Add unittests for new bridgedb.translations module. --- lib/bridgedb/test/test_translations.py | 78 ++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/lib/bridgedb/test/test_translations.py b/lib/bridgedb/test/test_translations.py new file mode 100644 index 0000000..ee15ac4 --- /dev/null +++ b/lib/bridgedb/test/test_translations.py @@ -0,0 +1,78 @@ +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# :copyright: (c) 2014, Isis Lovecruft +# (c) 2014, The Tor Project, Inc. +# :license: 3-Clause BSD, see LICENSE for licensing information + + +from twisted.trial import unittest + +from bridgedb import translations +from bridgedb.test.test_HTTPServer import DummyRequest + + +REALISH_HEADERS = { + b'Accept-Encoding': [b'gzip, deflate'], + b'User-Agent': [ + b'Mozilla/5.0 (X11; Linux x86_64; rv:28.0) Gecko/20100101 Firefox/28.0'], + b'Accept': [ + b'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'], +} + +# Add this to the above REALISH_HEADERS to use it: +ACCEPT_LANGUAGE_HEADER = { + b'Accept-Language': [b'de-de,en-gb;q=0.8,en;q=0.5,en-us;q=0.3'], +} + + +class TranslationsMiscTests(unittest.TestCase): + """Tests for module-level code in ``bridgedb.translations`` module.""" + + def test_getLocaleFromHTTPRequest_withLangParam(self): + """This request uses a '?lang=ar' param, without an 'Accept-Language' + header. + + The request result should be: ['ar', 'en', 'en-US']. + """ + request = DummyRequest([b"bridges"]) + request.headers.update(REALISH_HEADERS) + request.args.update({ + b'transport': [b'obfs3',], + b'lang': [b'ar',], + }) + + parsed = translations.getLocaleFromHTTPRequest(request) + self.assertEqual(parsed[0], 'ar') + self.assertEqual(parsed[1], 'en') + self.assertEqual(parsed[2], 'en_US') + self.assertEqual(len(parsed), 3) + + def test_getLocaleFromHTTPRequest_withLangParam_AcceptLanguage(self): + """This request uses a '?lang=ar' param, with an 'Accept-Language' + header which includes: ['de-de', 'en-gb', 'en', 'en-us']. + + The request result should be: ['fa', 'de-de', 'en-gb', 'en', 'en-us']. + """ + request = DummyRequest([b"options"]) + request.headers.update(ACCEPT_LANGUAGE_HEADER) + request.args.update({b'lang': [b'fa']}) + + parsed = translations.getLocaleFromHTTPRequest(request) + self.assertEqual(parsed[0], 'fa') + self.assertEqual(parsed[1], 'en') + self.assertEqual(parsed[2], 'en_US') + #self.assertEqual(parsed[3], 'en-gb') + self.assertEqual(len(parsed), 3) + + def test_getLocaleFromPlusAddr(self): + emailAddr = 'bridges(a)torproject.org' + replyLocale = translations.getLocaleFromPlusAddr(emailAddr) + self.assertEqual('en', replyLocale) + + def test_getLocaleFromPlusAddr_ar(self): + emailAddr = 'bridges+ar(a)torproject.org' + replyLocale = translations.getLocaleFromPlusAddr(emailAddr) + self.assertEqual('ar', replyLocale)

1 0

[bridgedb/develop] Move locate determination and translation code into separate module.
by isis＠torproject.org 17 Apr '14

17 Apr '14

commit ed438d0c2b00f02c29b60e561d37f241f6a6a4b8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 16 16:22:40 2014 +0000 Move locate determination and translation code into separate module. * ADD new bridgedb.translations module with the following methods: - getFirstSupportedLang(): Essentially the same as the original HTTPServer.getAssumedChosenLang() function, except that the determination of which languages are supported uses _lang.getLangs() instead (this has been in the _lang module for a long time, and was meant for that purpose). - getLocaleFromHTTPRequest(): This is taken mostly from the original setLocaleFromRequestHeader() (in the HTTPServer module) except that there was an extra function in the EmailServer module, called getLocaleFromRequest() ― which was not in use anywhere ― which included the parsing of '?lang=' HTTP GET/POST arguments. The parsing of '?lang=' was taken from that function and added to the original functionality of setLocaleFromRequestHeader(). This fixes part of ticket #9678: "'Select Language' button on bridges.tpo". - getLocaleFromPlusAddr(): Exactly the same as the original in the EmailServer module. - installTranslations(): Produces a gettext translation object, with fallback languages chained to it in order of client preference. - usingRTLLang(): Essentially the same as the original in the HTTPServer module, except that the parsing of supported langs again uses the _lang.getLangs() function, as above. * FIXES part of #9678: "'Select Language' button to bridges.tpo" --- lib/bridgedb/EmailServer.py | 29 ++-------- lib/bridgedb/HTTPServer.py | 94 +++----------------------------- lib/bridgedb/translations.py | 122 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 132 insertions(+), 113 deletions(-) diff --git a/lib/bridgedb/EmailServer.py b/lib/bridgedb/EmailServer.py index f9f43bb..c58ec53 100644 --- a/lib/bridgedb/EmailServer.py +++ b/lib/bridgedb/EmailServer.py @@ -30,6 +30,7 @@ from bridgedb.Dist import BadEmail, TooSoonEmail, IgnoreEmail from bridgedb import Dist from bridgedb import I18n from bridgedb import safelog +from bridgedb import translations from bridgedb.Filters import filterBridgesByIP6 from bridgedb.Filters import filterBridgesByIP4 from bridgedb.Filters import filterBridgesByTransport @@ -94,8 +95,8 @@ def getMailResponse(lines, ctx): # Look up the locale part in the 'To:' address, if there is one and get # the appropriate Translation object - lang = getLocaleFromPlusAddr(clientToaddr) - t = I18n.getLang(lang) + lang = translations.getLocaleFromPlusAddr(clientToaddr) + t = translations.installTranslations(lang) try: _, addrdomain = Dist.extractAddrSpec(clientAddr.lower()) @@ -287,30 +288,6 @@ def replyToMail(lines, ctx): reactor.connectTCP(ctx.smtpServer, ctx.smtpPort, factory) return d -def getLocaleFromPlusAddr(address): - """See whether the user sent his email to a 'plus' address, for - instance to bridgedb+fa@tpo. Plus addresses are the current - mechanism to set the reply language - """ - replyLocale = "en" - r = '.*(<)?(\w+\+(\w+)@\w+(?:\.\w+)+)(?(1)>)' - match = re.match(r, address) - if match: - replyLocale = match.group(3) - - return replyLocale - -def getLocaleFromRequest(request): - # See if we did get a request for a certain locale, otherwise fall back - # to 'en': - # Try evaluating the path /foo first, then check if we got a ?lang=foo - default_lang = lang = "en" - if len(request.path) > 1: - lang = request.path[1:] - if lang == default_lang: - lang = request.args.get("lang", [default_lang]) - lang = lang[0] - return I18n.getLang(lang) class MailContext(object): """Helper object that holds information used by email subsystem.""" diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 5e3ba37..79772c3 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -35,6 +35,7 @@ import bridgedb.I18n as I18n from bridgedb import captcha from bridgedb import crypto +from bridgedb import translations from bridgedb import txrecaptcha from bridgedb.Filters import filterBridgesByIP4 from bridgedb.Filters import filterBridgesByIP6 @@ -541,9 +542,10 @@ class WebResourceOptions(resource.Resource): def render_GET(self, request): rtl = False + langs = translations.getLocaleFromHTTPRequest(request) try: - rtl = usingRTLLang(request) + rtl = translations.usingRTLLang(langs) except Exception as err: # pragma: no cover logging.exception(err) @@ -664,7 +666,8 @@ class WebResourceBridges(resource.Resource): if countryCode: logging.debug("Client request from GeoIP CC: %s" % countryCode) - rtl = usingRTLLang(request) + langs = translations.getLocaleFromHTTPRequest(request) + rtl = translations.usingRTLLang(langs) if rtl: logging.debug("Rendering RTL response.") @@ -784,9 +787,10 @@ class WebRoot(resource.Resource): :param request: An incoming request. """ rtl = False + langs = translations.getLocaleFromHTTPRequest(request) try: - rtl = usingRTLLang(request) + rtl = translations.usingRTLLang(langs) except Exception as err: logging.exception(err) logging.error("The gettext files were not properly installed.") @@ -883,87 +887,3 @@ def addWebServer(cfg, dist, sched): raise SystemExit(error) return site - -def usingRTLLang(request): - """Check if we should translate the text into a RTL language - - Retrieve the headers from the request. Obtain the Accept-Language header - and decide if we need to translate the text. Install the requisite - languages via gettext, if so. Then, manually check which languages we - support. Choose the first language from the header that we support and - return True if it is a RTL language, else return False. - - :type request: :api:`twisted.web.server.Request` - :param request: An incoming request. - :rtype: bool - :returns: ``True`` if the preferred language is right-to-left; ``False`` - otherwise. - """ - langs = setLocaleFromRequestHeader(request) - - # Grab only the language (first two characters) so we know if the language - # is read right-to-left - #langs = [ lang[:2] for lang in langs ] - lang = getAssumedChosenLang(langs) - if lang in rtl_langs: - return True - return False - -def getAssumedChosenLang(langs): - """Return the first language in **langs** that we support. - - :param list langs: All requested languages - :rtype: str - :returns: A country code for the client's preferred language. - """ - i18npath = os.path.join(os.path.dirname(__file__), 'i18n') - path = filepath.FilePath(i18npath) - assert path.isdir() - - lang = 'en-US' - supp_langs = path.listdir() + ['en'] - for l in langs: - if l in supp_langs: - lang = l - break - return lang - -def setLocaleFromRequestHeader(request): - """Retrieve the languages from the accept-language header and install them. - - Parse the languages in the header, and attempt to install the first one in - the list. If that fails, we receive a :class:`gettext.NullTranslation` - object, if it worked then we have a :class:`gettext.GNUTranslation` - object. Whichever one we end up with, get the other languages and add them - as fallbacks to the first. Lastly, install this chain of translations. - - :type request: :api:`twisted.web.server.Request` - :param request: An incoming request from a client. - :rtype: list - :returns: All requested languages. - """ - logging.debug("Getting client 'Accept-Language' header...") - header = request.getHeader('accept-language') - - if header is None: - logging.debug("Client sent no 'Accept-Language' header. Using fallback.") - header = 'en,en-US' - - localedir = os.path.join(os.path.dirname(__file__), 'i18n/') - langs = headers.parseAcceptLanguage(header) - ## XXX the 'Accept-Language' header is potentially identifying - logging.debug("Client Accept-Language (top 5): %s" % langs[:5]) - - try: - language = gettext.translation("bridgedb", localedir=localedir, - languages=langs, fallback=True) - for lang in langs: - language.add_fallback(gettext.translation("bridgedb", - localedir=localedir, - languages=langs, - fallback=True)) - except IOError as error: - logging.error(error.message) - - language.install(unicode=True) - return langs diff --git a/lib/bridgedb/translations.py b/lib/bridgedb/translations.py new file mode 100644 index 0000000..3085938 --- /dev/null +++ b/lib/bridgedb/translations.py @@ -0,0 +1,122 @@ +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_translations -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2007-2014, The Tor Project, Inc. +# :license: 3-Clause BSD, see LICENSE for licensing information + +import gettext +import logging +import os +import re + +from bridgedb import _langs +from bridgedb import safelog +from bridgedb.parse import headers + + +TRANSLATIONS_DIR = os.path.join(os.path.dirname(__file__), 'i18n') + + +def getFirstSupportedLang(langs): + """Return the first language in **langs** that we support. + + :param list langs: All requested languages + :rtype: str + :returns: A country code for the client's preferred language. + """ + lang = 'en-US' + supported = _langs.get_langs() + + for l in langs: + if l in supported: + lang = l + break + return lang + +def getLocaleFromHTTPRequest(request): + """Retrieve the languages from an HTTP ``Accept-Language:`` header. + + Parse the languages from the header, use them to install a + ``gettext.translation`` chain via :func:`installTranslations`, and lastly + return the requested languages. + + :type request: :api:`twisted.web.server.Request` + :param request: An incoming request from a client. + :rtype: list + :returns: All requested languages. + """ + header = request.getHeader('accept-language') + if header is None: + logging.debug("Client sent no 'Accept-Language' header. Using fallback.") + header = 'en,en-US' + + langs = headers.parseAcceptLanguage(header) + if not safelog.safe_logging: # pragma: no cover + logging.debug("Client Accept-Language (top 5): %s" % langs[:5]) + + # Check if we got a ?lang=foo argument, and if we did, insert it first + chosenLang = request.args.get("lang", [None,])[0] + if chosenLang: + logging.debug("Client requested language: %r" % chosenLang) + langs.insert(0, chosenLang) + + installTranslations(langs) + return langs + +def getLocaleFromPlusAddr(address): + """See whether the user sent his email to a 'plus' address, for instance to + bridges+fa(a)bridges.torproject.org. Plus addresses are the current + mechanism to set the reply language. + """ + replyLocale = "en" + r = '.*(<)?(\w+\+(\w+)@\w+(?:\.\w+)+)(?(1)>)' + match = re.match(r, address) + if match: + replyLocale = match.group(3) + + return replyLocale + +def installTranslations(langs): + """Create a ``gettext.translation`` chain for all **langs**. + + Attempt to install the first language in the **langs** list. If that + fails, we receive a ``gettext.NullTranslation`` object, and if it worked + then we have a ``gettext.GNUTranslation`` object. Whichever one we end up + with, get the other languages and add them as fallbacks to the + first. Lastly, install this chain of translations. + + :param list langs: A list of language codes. + :returns: A ``gettext.NullTranslation`` or ``gettext.GNUTranslation`` with + fallback languages set. + """ + try: + language = gettext.translation("bridgedb", localedir=TRANSLATIONS_DIR, + languages=langs, fallback=True) + for lang in langs: + language.add_fallback( + gettext.translation("bridgedb", localedir=TRANSLATIONS_DIR, + languages=langs, fallback=True)) + except IOError as error: + logging.error(error.message) + + language.install(unicode=True) + return language + +def usingRTLLang(langs): + """Check if we should translate the text into a RTL language. + + Choose the first language from the **langs** list that we support and + return True if it is a RTL language, else return False. + + :param list langs: An incoming request. + :rtype: bool + :returns: ``True`` if the preferred language is right-to-left; ``False`` + otherwise. + """ + lang = getFirstSupportedLang(langs) + if lang in _langs.RTL_LANGS: + return True + return False

1 0