~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/win32utils.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Win32-specific helper functions
18
18
 
19
19
Only one dependency: ctypes should be installed.
20
20
"""
21
21
 
 
22
from __future__ import absolute_import
 
23
 
 
24
import glob
 
25
import operator
22
26
import os
23
27
import struct
24
28
import sys
25
29
 
 
30
from bzrlib import (
 
31
    cmdline,
 
32
    symbol_versioning,
 
33
    )
 
34
from bzrlib.i18n import gettext
26
35
 
27
36
# Windows version
28
37
if sys.platform == 'win32':
60
69
else:
61
70
    if winver == 'Windows 98':
62
71
        create_buffer = ctypes.create_string_buffer
 
72
        def extract_buffer(buf):
 
73
            return buf.value.decode("mbcs")
63
74
        suffix = 'A'
64
75
    else:
65
76
        create_buffer = ctypes.create_unicode_buffer
 
77
        extract_buffer = operator.attrgetter("value")
66
78
        suffix = 'W'
67
79
try:
68
 
    import win32file
69
 
    has_win32file = True
70
 
except ImportError:
71
 
    has_win32file = False
72
 
try:
73
 
    import win32api
74
 
    has_win32api = True
75
 
except ImportError:
76
 
    has_win32api = False
 
80
    import pywintypes
 
81
    has_pywintypes = True
 
82
except ImportError:
 
83
    has_pywintypes = has_win32file = has_win32api = False
 
84
else:
 
85
    try:
 
86
        import win32file
 
87
        has_win32file = True
 
88
    except ImportError:
 
89
        has_win32file = False
 
90
    try:
 
91
        import win32api
 
92
        has_win32api = True
 
93
    except ImportError:
 
94
        has_win32api = False
77
95
 
78
96
# pulling in win32com.shell is a bit of overhead, and normally we don't need
79
97
# it as ctypes is preferred and common.  lazy_imports and "optional"
96
114
UNLEN = 256
97
115
MAX_COMPUTERNAME_LENGTH = 31
98
116
 
 
117
# Registry data type ids
 
118
REG_SZ = 1
 
119
REG_EXPAND_SZ = 2
 
120
 
 
121
 
 
122
def debug_memory_win32api(message='', short=True):
 
123
    """Use trace.note() to dump the running memory info."""
 
124
    from bzrlib import trace
 
125
    if has_ctypes:
 
126
        class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
 
127
            """Used by GetProcessMemoryInfo"""
 
128
            _fields_ = [('cb', ctypes.c_ulong),
 
129
                        ('PageFaultCount', ctypes.c_ulong),
 
130
                        ('PeakWorkingSetSize', ctypes.c_size_t),
 
131
                        ('WorkingSetSize', ctypes.c_size_t),
 
132
                        ('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
 
133
                        ('QuotaPagedPoolUsage', ctypes.c_size_t),
 
134
                        ('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
 
135
                        ('QuotaNonPagedPoolUsage', ctypes.c_size_t),
 
136
                        ('PagefileUsage', ctypes.c_size_t),
 
137
                        ('PeakPagefileUsage', ctypes.c_size_t),
 
138
                        ('PrivateUsage', ctypes.c_size_t),
 
139
                       ]
 
140
        cur_process = ctypes.windll.kernel32.GetCurrentProcess()
 
141
        mem_struct = PROCESS_MEMORY_COUNTERS_EX()
 
142
        ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
 
143
            ctypes.byref(mem_struct),
 
144
            ctypes.sizeof(mem_struct))
 
145
        if not ret:
 
146
            trace.note(gettext('Failed to GetProcessMemoryInfo()'))
 
147
            return
 
148
        info = {'PageFaultCount': mem_struct.PageFaultCount,
 
149
                'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
 
150
                'WorkingSetSize': mem_struct.WorkingSetSize,
 
151
                'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
 
152
                'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
 
153
                'QuotaPeakNonPagedPoolUsage':
 
154
                    mem_struct.QuotaPeakNonPagedPoolUsage,
 
155
                'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
 
156
                'PagefileUsage': mem_struct.PagefileUsage,
 
157
                'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
 
158
                'PrivateUsage': mem_struct.PrivateUsage,
 
159
               }
 
160
    elif has_win32api:
 
161
        import win32process
 
162
        # win32process does not return PrivateUsage, because it doesn't use
 
163
        # PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
 
164
        proc = win32process.GetCurrentProcess()
 
165
        info = win32process.GetProcessMemoryInfo(proc)
 
166
    else:
 
167
        trace.note(gettext('Cannot debug memory on win32 without ctypes'
 
168
                   ' or win32process'))
 
169
        return
 
170
    if short:
 
171
        # using base-2 units (see HACKING.txt).
 
172
        trace.note(gettext('WorkingSize {0:>7}KiB'
 
173
                   '\tPeakWorking {1:>7}KiB\t{2}').format(
 
174
                   info['WorkingSetSize'] / 1024,
 
175
                   info['PeakWorkingSetSize'] / 1024,
 
176
                   message))
 
177
        return
 
178
    if message:
 
179
        trace.note('%s', message)
 
180
    trace.note(gettext('WorkingSize       %8d KiB'), info['WorkingSetSize'] / 1024)
 
181
    trace.note(gettext('PeakWorking       %8d KiB'), info['PeakWorkingSetSize'] / 1024)
 
182
    trace.note(gettext('PagefileUsage     %8d KiB'), info.get('PagefileUsage', 0) / 1024)
 
183
    trace.note(gettext('PeakPagefileUsage %8d KiB'),
 
184
               info.get('PeakPagefileUsage', 0) / 1024)
 
185
    trace.note(gettext('PrivateUsage      %8d KiB'), info.get('PrivateUsage', 0) / 1024)
 
186
    trace.note(gettext('PageFaultCount    %8d'), info.get('PageFaultCount', 0))
 
187
 
99
188
 
100
189
def get_console_size(defaultx=80, defaulty=25):
101
190
    """Return size of current console.
109
198
        return (defaultx, defaulty)
110
199
 
111
200
    # To avoid problem with redirecting output via pipe
112
 
    # need to use stderr instead of stdout
 
201
    # we need to use stderr instead of stdout
113
202
    h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
114
203
    csbi = ctypes.create_string_buffer(22)
115
204
    res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
116
205
 
117
206
    if res:
118
207
        (bufx, bufy, curx, cury, wattr,
119
 
        left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
 
208
        left, top, right, bottom, maxx, maxy) = struct.unpack(
 
209
            "hhhhHhhhhhh", csbi.raw)
120
210
        sizex = right - left + 1
121
211
        sizey = bottom - top + 1
122
212
        return (sizex, sizey)
126
216
 
127
217
def _get_sh_special_folder_path(csidl):
128
218
    """Call SHGetSpecialFolderPathW if available, or return None.
129
 
    
 
219
 
130
220
    Result is always unicode (or None).
131
221
    """
132
222
    if has_ctypes:
167
257
    one that moves with the user as they logon to different machines, and
168
258
    a 'local' one that stays local to the machine.  This returns the 'roaming'
169
259
    directory, and thus is suitable for storing user-preferences, etc.
170
 
 
171
 
    Returned value can be unicode or plain string.
172
 
    To convert plain string to unicode use
173
 
    s.decode(osutils.get_user_encoding())
174
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
175
260
    """
176
261
    appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
177
262
    if appdata:
178
263
        return appdata
179
 
    # from env variable
180
 
    appdata = os.environ.get('APPDATA')
181
 
    if appdata:
182
 
        return appdata
183
 
    # if we fall to this point we on win98
184
 
    # at least try C:/WINDOWS/Application Data
185
 
    windir = os.environ.get('windir')
186
 
    if windir:
187
 
        appdata = os.path.join(windir, 'Application Data')
188
 
        if os.path.isdir(appdata):
189
 
            return appdata
190
 
    # did not find anything
191
 
    return None
 
264
    # Use APPDATA if defined, will return None if not
 
265
    return get_environ_unicode('APPDATA')
192
266
 
193
267
 
194
268
def get_local_appdata_location():
200
274
    a 'local' one that stays local to the machine.  This returns the 'local'
201
275
    directory, and thus is suitable for caches, temp files and other things
202
276
    which don't need to move with the user.
203
 
 
204
 
    Returned value can be unicode or plain string.
205
 
    To convert plain string to unicode use
206
 
    s.decode(bzrlib.user_encoding)
207
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
208
277
    """
209
278
    local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
210
279
    if local:
211
280
        return local
212
281
    # Vista supplies LOCALAPPDATA, but XP and earlier do not.
213
 
    local = os.environ.get('LOCALAPPDATA')
 
282
    local = get_environ_unicode('LOCALAPPDATA')
214
283
    if local:
215
284
        return local
216
285
    return get_appdata_location()
221
290
    Assume on win32 it's the <My Documents> folder.
222
291
    If location cannot be obtained return system drive root,
223
292
    i.e. C:\
224
 
 
225
 
    Returned value can be unicode or plain sring.
226
 
    To convert plain string to unicode use
227
 
    s.decode(osutils.get_user_encoding())
228
293
    """
229
294
    home = _get_sh_special_folder_path(CSIDL_PERSONAL)
230
295
    if home:
231
296
        return home
232
 
    # try for HOME env variable
233
 
    home = os.path.expanduser('~')
234
 
    if home != '~':
 
297
    home = get_environ_unicode('HOME')
 
298
    if home is not None:
235
299
        return home
 
300
    homepath = get_environ_unicode('HOMEPATH')
 
301
    if homepath is not None:
 
302
        return os.path.join(get_environ_unicode('HOMEDIR', ''), home)
236
303
    # at least return windows root directory
237
 
    windir = os.environ.get('windir')
 
304
    windir = get_environ_unicode('WINDIR')
238
305
    if windir:
239
306
        return os.path.splitdrive(windir)[0] + '/'
240
307
    # otherwise C:\ is good enough for 98% users
241
 
    return 'C:/'
 
308
    return unicode('C:/')
242
309
 
243
310
 
244
311
def get_user_name():
245
312
    """Return user name as login name.
246
313
    If name cannot be obtained return None.
247
 
 
248
 
    Returned value can be unicode or plain sring.
249
 
    To convert plain string to unicode use
250
 
    s.decode(osutils.get_user_encoding())
251
314
    """
252
315
    if has_ctypes:
253
316
        try:
259
322
            buf = create_buffer(UNLEN+1)
260
323
            n = ctypes.c_int(UNLEN+1)
261
324
            if GetUserName(buf, ctypes.byref(n)):
262
 
                return buf.value
 
325
                return extract_buffer(buf)
263
326
    # otherwise try env variables
264
 
    return os.environ.get('USERNAME', None)
 
327
    return get_environ_unicode('USERNAME')
265
328
 
266
329
 
267
330
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
272
335
    """Return host machine name.
273
336
    If name cannot be obtained return None.
274
337
 
275
 
    :return: A unicode string representing the host name. On win98, this may be
276
 
        a plain string as win32 api doesn't support unicode.
 
338
    :return: A unicode string representing the host name.
277
339
    """
278
340
    if has_win32api:
279
341
        try:
296
358
            if (GetComputerNameEx is not None
297
359
                and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
298
360
                                      buf, ctypes.byref(n))):
299
 
                return buf.value
 
361
                return extract_buffer(buf)
300
362
 
301
363
            # Try GetComputerName in case GetComputerNameEx wasn't found
302
364
            # It returns the NETBIOS name, which isn't as good, but still ok.
306
368
                                      None)
307
369
            if (GetComputerName is not None
308
370
                and GetComputerName(buf, ctypes.byref(n))):
309
 
                return buf.value
310
 
    # otherwise try env variables, which will be 'mbcs' encoded
311
 
    # on Windows (Python doesn't expose the native win32 unicode environment)
312
 
    # According to this:
313
 
    # http://msdn.microsoft.com/en-us/library/aa246807.aspx
314
 
    # environment variables should always be encoded in 'mbcs'.
315
 
    try:
316
 
        return os.environ['COMPUTERNAME'].decode("mbcs")
317
 
    except KeyError:
318
 
        return None
319
 
 
320
 
 
 
371
                return extract_buffer(buf)
 
372
    return get_environ_unicode('COMPUTERNAME')
 
373
 
 
374
 
 
375
@symbol_versioning.deprecated_function(
 
376
    symbol_versioning.deprecated_in((2, 5, 0)))
321
377
def _ensure_unicode(s):
322
 
    from bzrlib import osutils
323
378
    if s and type(s) != unicode:
324
379
        from bzrlib import osutils
325
380
        s = s.decode(osutils.get_user_encoding())
326
381
    return s
327
382
 
328
383
 
329
 
def get_appdata_location_unicode():
330
 
    return _ensure_unicode(get_appdata_location())
331
 
 
332
 
def get_home_location_unicode():
333
 
    return _ensure_unicode(get_home_location())
334
 
 
335
 
def get_user_name_unicode():
336
 
    return _ensure_unicode(get_user_name())
337
 
 
338
 
def get_host_name_unicode():
339
 
    return _ensure_unicode(get_host_name())
 
384
get_appdata_location_unicode = symbol_versioning.deprecated_function(
 
385
    symbol_versioning.deprecated_in((2, 5, 0)))(get_appdata_location)
 
386
 
 
387
get_home_location_unicode = symbol_versioning.deprecated_function(
 
388
    symbol_versioning.deprecated_in((2, 5, 0)))(get_home_location)
 
389
 
 
390
get_user_name_unicode = symbol_versioning.deprecated_function(
 
391
    symbol_versioning.deprecated_in((2, 5, 0)))(get_user_name)
 
392
 
 
393
get_host_name_unicode = symbol_versioning.deprecated_function(
 
394
    symbol_versioning.deprecated_in((2, 5, 0)))(get_host_name)
340
395
 
341
396
 
342
397
def _ensure_with_dir(path):
343
 
    if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
 
398
    if (not os.path.split(path)[0] or path.startswith(u'*')
 
399
        or path.startswith(u'?')):
344
400
        return u'./' + path, True
345
401
    else:
346
402
        return path, False
347
 
    
 
403
 
348
404
def _undo_ensure_with_dir(path, corrected):
349
405
    if corrected:
350
406
        return path[2:]
352
408
        return path
353
409
 
354
410
 
 
411
def glob_one(possible_glob):
 
412
    """Same as glob.glob().
 
413
 
 
414
    work around bugs in glob.glob()
 
415
    - Python bug #1001604 ("glob doesn't return unicode with ...")
 
416
    - failing expansion for */* with non-iso-8859-* chars
 
417
    """
 
418
    corrected_glob, corrected = _ensure_with_dir(possible_glob)
 
419
    glob_files = glob.glob(corrected_glob)
 
420
 
 
421
    if not glob_files:
 
422
        # special case to let the normal code path handle
 
423
        # files that do not exist, etc.
 
424
        glob_files = [possible_glob]
 
425
    elif corrected:
 
426
        glob_files = [_undo_ensure_with_dir(elem, corrected)
 
427
                      for elem in glob_files]
 
428
    return [elem.replace(u'\\', u'/') for elem in glob_files]
 
429
 
355
430
 
356
431
def glob_expand(file_list):
357
432
    """Replacement for glob expansion by the shell.
366
441
    """
367
442
    if not file_list:
368
443
        return []
369
 
    import glob
370
444
    expanded_file_list = []
371
445
    for possible_glob in file_list:
372
 
        
373
 
        # work around bugs in glob.glob()
374
 
        # - Python bug #1001604 ("glob doesn't return unicode with ...")
375
 
        # - failing expansion for */* with non-iso-8859-* chars
376
 
        possible_glob, corrected = _ensure_with_dir(possible_glob)
377
 
        glob_files = glob.glob(possible_glob)
378
 
 
379
 
        if glob_files == []:
380
 
            # special case to let the normal code path handle
381
 
            # files that do not exists
382
 
            expanded_file_list.append(
383
 
                _undo_ensure_with_dir(possible_glob, corrected))
384
 
        else:
385
 
            glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
386
 
            expanded_file_list += glob_files
387
 
            
388
 
    return [elem.replace(u'\\', u'/') for elem in expanded_file_list] 
 
446
        expanded_file_list.extend(glob_one(possible_glob))
 
447
    return expanded_file_list
389
448
 
390
449
 
391
450
def get_app_path(appname):
392
 
    """Look up in Windows registry for full path to application executable.
393
 
    Typicaly, applications create subkey with their basename
 
451
    r"""Look up in Windows registry for full path to application executable.
 
452
    Typically, applications create subkey with their basename
394
453
    in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
395
454
 
396
455
    :param  appname:    name of application (if no filename extension
399
458
                or appname itself if nothing found.
400
459
    """
401
460
    import _winreg
 
461
 
 
462
    basename = appname
 
463
    if not os.path.splitext(basename)[1]:
 
464
        basename = appname + '.exe'
 
465
 
402
466
    try:
403
467
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
404
 
                               r'SOFTWARE\Microsoft\Windows'
405
 
                               r'\CurrentVersion\App Paths')
 
468
            'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
 
469
            basename)
406
470
    except EnvironmentError:
407
471
        return appname
408
472
 
409
 
    basename = appname
410
 
    if not os.path.splitext(basename)[1]:
411
 
        basename = appname + '.exe'
412
473
    try:
413
474
        try:
414
 
            fullpath = _winreg.QueryValue(hkey, basename)
 
475
            path, type_id = _winreg.QueryValueEx(hkey, '')
415
476
        except WindowsError:
416
 
            fullpath = appname
 
477
            return appname
417
478
    finally:
418
479
        _winreg.CloseKey(hkey)
419
480
 
420
 
    return fullpath
 
481
    if type_id == REG_SZ:
 
482
        return path
 
483
    if type_id == REG_EXPAND_SZ and has_win32api:
 
484
        fullpath = win32api.ExpandEnvironmentStrings(path)
 
485
        if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
 
486
            fullpath = fullpath[1:-1]   # remove quotes around value
 
487
        return fullpath
 
488
    return appname
421
489
 
422
490
 
423
491
def set_file_attr_hidden(path):
424
492
    """Set file attributes to hidden if possible"""
425
493
    if has_win32file:
426
 
        win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
 
494
        if winver != 'Windows 98':
 
495
            SetFileAttributes = win32file.SetFileAttributesW
 
496
        else:
 
497
            SetFileAttributes = win32file.SetFileAttributes
 
498
        try:
 
499
            SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
 
500
        except pywintypes.error, e:
 
501
            from bzrlib import trace
 
502
            trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
 
503
 
 
504
 
 
505
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
 
506
    """Convert a Unicode command line into a list of argv arguments.
 
507
 
 
508
    It performs wildcard expansion to make wildcards act closer to how they
 
509
    work in posix shells, versus how they work by default on Windows. Quoted
 
510
    arguments are left untouched.
 
511
 
 
512
    :param command_line: The unicode string to split into an arg list.
 
513
    :param single_quotes_allowed: Whether single quotes are accepted as quoting
 
514
                                  characters like double quotes. False by
 
515
                                  default.
 
516
    :return: A list of unicode strings.
 
517
    """
 
518
    # First, split the command line
 
519
    s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
 
520
    
 
521
    # Bug #587868 Now make sure that the length of s agrees with sys.argv 
 
522
    # we do this by simply counting the number of arguments in each. The counts should 
 
523
    # agree no matter what encoding sys.argv is in (AFAIK) 
 
524
    # len(arguments) < len(sys.argv) should be an impossibility since python gets 
 
525
    # args from the very same PEB as does GetCommandLineW
 
526
    arguments = list(s)
 
527
    
 
528
    # Now shorten the command line we get from GetCommandLineW to match sys.argv
 
529
    if len(arguments) < len(argv):
 
530
        raise AssertionError("Split command line can't be shorter than argv")
 
531
    arguments = arguments[len(arguments) - len(argv):]
 
532
    
 
533
    # Carry on to process globs (metachars) in the command line
 
534
    # expand globs if necessary
 
535
    # TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
 
536
    #       '**/' style globs
 
537
    args = []
 
538
    for is_quoted, arg in arguments:
 
539
        if is_quoted or not glob.has_magic(arg):
 
540
            args.append(arg)
 
541
        else:
 
542
            args.extend(glob_one(arg))
 
543
    return args
 
544
 
 
545
 
 
546
if has_ctypes and winver == 'Windows NT':
 
547
    def get_unicode_argv():
 
548
        prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
 
549
        GetCommandLineW = prototype(("GetCommandLineW",
 
550
                                     ctypes.windll.kernel32))
 
551
        command_line = GetCommandLineW()
 
552
        if command_line is None:
 
553
            raise ctypes.WinError()
 
554
        # Skip the first argument, since we only care about parameters
 
555
        argv = _command_line_to_argv(command_line, sys.argv)[1:]
 
556
        return argv
 
557
    
 
558
 
 
559
    def get_environ_unicode(key, default=None):
 
560
        """Get `key` from environment as unicode or `default` if unset
 
561
 
 
562
        The environment is natively unicode on modern windows versions but
 
563
        Python 2 only accesses it through the legacy bytestring api.
 
564
 
 
565
        Environmental variable names are case insenstive on Windows.
 
566
 
 
567
        A large enough buffer will be allocated to retrieve the value, though
 
568
        it may take two calls to the underlying library function.
 
569
 
 
570
        This needs ctypes because pywin32 does not expose the wide version.
 
571
        """
 
572
        cfunc = getattr(get_environ_unicode, "_c_function", None)
 
573
        if cfunc is None:
 
574
            from ctypes.wintypes import DWORD, LPCWSTR, LPWSTR
 
575
            cfunc = ctypes.WINFUNCTYPE(DWORD, LPCWSTR, LPWSTR, DWORD)(
 
576
                ("GetEnvironmentVariableW", ctypes.windll.kernel32))
 
577
            get_environ_unicode._c_function = cfunc
 
578
        buffer_size = 256 # heuristic, 256 characters often enough
 
579
        while True:
 
580
            buffer = ctypes.create_unicode_buffer(buffer_size)
 
581
            length = cfunc(key, buffer, buffer_size)
 
582
            if not length:
 
583
                code = ctypes.GetLastError()
 
584
                if code == 203: # ERROR_ENVVAR_NOT_FOUND
 
585
                    return default
 
586
                raise ctypes.WinError(code)
 
587
            if buffer_size > length:
 
588
                return buffer[:length]
 
589
            buffer_size = length
 
590
else:
 
591
    get_unicode_argv = None
 
592
    def get_environ_unicode(key, default=None):
 
593
        """Get `key` from environment as unicode or `default` if unset
 
594
 
 
595
        Fallback version that should basically never be needed.
 
596
        """
 
597
        from bzrlib import osutils
 
598
        try:
 
599
            return os.environ[key].decode(osutils.get_user_encoding())
 
600
        except KeyError:
 
601
            return default
 
602
 
 
603
 
 
604
if has_win32api:
 
605
    def _pywin32_is_local_pid_dead(pid):
 
606
        """True if pid doesn't correspond to live process on this machine"""
 
607
        try:
 
608
            handle = win32api.OpenProcess(1, False, pid) # PROCESS_TERMINATE
 
609
        except pywintypes.error, e:
 
610
            if e[0] == 5: # ERROR_ACCESS_DENIED
 
611
                # Probably something alive we're not allowed to kill
 
612
                return False
 
613
            elif e[0] == 87: # ERROR_INVALID_PARAMETER
 
614
                return True
 
615
            raise
 
616
        handle.close()
 
617
        return False
 
618
    is_local_pid_dead = _pywin32_is_local_pid_dead
 
619
elif has_ctypes and sys.platform == 'win32':
 
620
    from ctypes.wintypes import BOOL, DWORD, HANDLE
 
621
    _kernel32 = ctypes.windll.kernel32
 
622
    _CloseHandle = ctypes.WINFUNCTYPE(BOOL, HANDLE)(
 
623
        ("CloseHandle", _kernel32))
 
624
    _OpenProcess = ctypes.WINFUNCTYPE(HANDLE, DWORD, BOOL, DWORD)(
 
625
        ("OpenProcess", _kernel32))
 
626
    def _ctypes_is_local_pid_dead(pid):
 
627
        """True if pid doesn't correspond to live process on this machine"""
 
628
        handle = _OpenProcess(1, False, pid) # PROCESS_TERMINATE
 
629
        if not handle:
 
630
            errorcode = ctypes.GetLastError()
 
631
            if errorcode == 5: # ERROR_ACCESS_DENIED
 
632
                # Probably something alive we're not allowed to kill
 
633
                return False
 
634
            elif errorcode == 87: # ERROR_INVALID_PARAMETER
 
635
                return True
 
636
            raise ctypes.WinError(errorcode)
 
637
        _CloseHandle(handle)
 
638
        return False
 
639
    is_local_pid_dead = _ctypes_is_local_pid_dead
 
640
 
 
641
 
 
642
def _is_pywintypes_error(evalue):
 
643
    """True if exception instance is an error from pywin32"""
 
644
    if has_pywintypes and isinstance(evalue, pywintypes.error):
 
645
        return True
 
646
    return False