changeset 44825:2632c1ed8f34 stable

hgweb: encode WSGI environment like OS environment Previously, the WSGI environment keys and values were encoded using latin-1. This resulted in a crash if a WSGI environment key or value could not be encoded using latin-1. On Unix, the OS environment is byte-based. Therefore we should do the reverse of what Python does for os.environ. On Windows, there’s no native byte-based OS environment. Therefore we should do the same as what mercurial.encoding does with the OS environment.
author Manuel Jacob <me@manueljacob.de>
date Thu, 25 Jun 2020 03:46:07 +0200
parents 839328c5a728
children 1bab6b61b62b 05277278f177
files mercurial/hgweb/request.py tests/test-wsgirequest.py
diffstat 2 files changed, 23 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/hgweb/request.py	Thu Jun 25 03:10:13 2020 +0200
+++ b/mercurial/hgweb/request.py	Thu Jun 25 03:46:07 2020 +0200
@@ -12,6 +12,7 @@
 
 from ..thirdparty import attr
 from .. import (
+    encoding,
     error,
     pycompat,
     util,
@@ -162,10 +163,18 @@
     # strings on Python 3 must be between \00000-\000FF. We deal with bytes
     # in Mercurial, so mass convert string keys and values to bytes.
     if pycompat.ispy3:
+
         def tobytes(s):
             if not isinstance(s, str):
                 return s
-            return s.encode('latin-1')
+            if pycompat.iswindows:
+                # This is what mercurial.encoding does for os.environ on
+                # Windows.
+                return encoding.strtolocal(s)
+            else:
+                # This is what is documented to be used for os.environ on Unix.
+                return pycompat.fsencode(s)
+
         env = {tobytes(k): tobytes(v) for k, v in pycompat.iteritems(env)}
 
     # Some hosting solutions are emulating hgwebdir, and dispatching directly
--- a/tests/test-wsgirequest.py	Thu Jun 25 03:10:13 2020 +0200
+++ b/tests/test-wsgirequest.py	Thu Jun 25 03:46:07 2020 +0200
@@ -3,7 +3,7 @@
 import unittest
 
 from mercurial.hgweb import request as requestmod
-from mercurial import error
+from mercurial import error, pycompat
 
 DEFAULT_ENV = {
     'REQUEST_METHOD': 'GET',
@@ -432,6 +432,18 @@
         self.assertEqual(r.dispatchpath, b'path1/path2')
         self.assertEqual(r.reponame, b'repo')
 
+    def testenvencoding(self):
+        if pycompat.iswindows:
+            # On Windows, we can't generally know which non-ASCII characters
+            # are supported.
+            r = parse(DEFAULT_ENV, extra={'foo': 'bar'})
+            self.assertEqual(r.rawenv[b'foo'], b'bar')
+        else:
+            # Unix is byte-based. Therefore we test all possible bytes.
+            b = b''.join(pycompat.bytechr(i) for i in range(256))
+            r = parse(DEFAULT_ENV, extra={'foo': pycompat.fsdecode(b)})
+            self.assertEqual(r.rawenv[b'foo'], b)
+
 
 if __name__ == '__main__':
     import silenttestrunner