From: Daira Hopwood <daira@jacaranda.org>
Date: Wed, 4 Feb 2015 16:49:40 +0000 (+0000)
Subject: Further refine error handling in windows_getenv to avoid a Win32 API design flaw.
X-Git-Url: https://git.rkrishnan.org/uri?a=commitdiff_plain;h=69a2979040fdbf7491b6b45aefada64ca799602f;p=tahoe-lafs%2Ftahoe-lafs.git

Further refine error handling in windows_getenv to avoid a Win32 API design flaw.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
---

diff --git a/src/allmydata/util/fileutil.py b/src/allmydata/util/fileutil.py
index 7bb25e8e..74132733 100644
--- a/src/allmydata/util/fileutil.py
+++ b/src/allmydata/util/fileutil.py
@@ -408,13 +408,15 @@ def windows_getenv(name):
         raise AssertionError("name must be Unicode")
 
     n = GetEnvironmentVariableW(name, None, 0)
+    # GetEnvironmentVariableW returns DWORD, so n cannot be negative.
     if n == 0:
         err = GetLastError()
         raise OSError("Windows error %d attempting to read size of environment variable %r"
                       % (err, name))
-    elif n < 0:
-        raise OSError("Unexpected result %d from GetEnvironmentVariableW attempting to read size of environment variable %r"
-                      % (n, name))
+    if n == 1:
+        # Avoid an ambiguity between a zero-length string and an error in the return value of the
+        # call to GetEnvironmentVariableW below.
+        return u""
 
     buf = create_unicode_buffer(u'\0'*n)
     retval = GetEnvironmentVariableW(name, buf, n)
@@ -422,9 +424,9 @@ def windows_getenv(name):
         err = GetLastError()
         raise OSError("Windows error %d attempting to read environment variable %r"
                       % (err, name))
-    elif retval != n-1:
-        raise OSError("Unexpected result %d from GetEnvironmentVariableW attempting to read environment variable %r"
-                      % (n, name))
+    if retval >= n:
+        raise OSError("Unexpected result %d (expected less than %d) from GetEnvironmentVariableW attempting to read environment variable %r"
+                      % (retval, n, name))
 
     return buf.value