← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/win32utils.py

  • Committer: Vincent Ladeuil
  • Date: 2013-07-13 19:05:24 UTC
  • mto: This revision was merged to the branch mainline in revision 6580.
  • Revision ID: v.ladeuil+lp@free.fr-20130713190524-3bclzq4hpwkd6hkw
Urgh. pqm still runs python 2.6 so we have to maintain compatibility to land the fix 8-(

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/win32utils.py
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
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
 
99
121
 
100
122
def debug_memory_win32api(message='', short=True):
101
123
    """Use trace.note() to dump the running memory info."""
121
143
            ctypes.byref(mem_struct),
122
144
            ctypes.sizeof(mem_struct))
123
145
        if not ret:
124
 
            trace.note('Failed to GetProcessMemoryInfo()')
 
146
            trace.note(gettext('Failed to GetProcessMemoryInfo()'))
125
147
            return
126
148
        info = {'PageFaultCount': mem_struct.PageFaultCount,
127
149
                'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
128
150
                'WorkingSetSize': mem_struct.WorkingSetSize,
129
151
                'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
130
152
                'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
131
 
                'QuotaPeakNonPagedPoolUsage': mem_struct.QuotaPeakNonPagedPoolUsage,
 
153
                'QuotaPeakNonPagedPoolUsage':
 
154
                    mem_struct.QuotaPeakNonPagedPoolUsage,
132
155
                'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
133
156
                'PagefileUsage': mem_struct.PagefileUsage,
134
157
                'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
141
164
        proc = win32process.GetCurrentProcess()
142
165
        info = win32process.GetProcessMemoryInfo(proc)
143
166
    else:
144
 
        trace.note('Cannot debug memory on win32 without ctypes'
145
 
                   ' or win32process')
 
167
        trace.note(gettext('Cannot debug memory on win32 without ctypes'
 
168
                   ' or win32process'))
146
169
        return
147
170
    if short:
148
 
        trace.note('WorkingSize %7dKB'
149
 
                   '\tPeakWorking %7dKB\t%s',
 
171
        # using base-2 units (see HACKING.txt).
 
172
        trace.note(gettext('WorkingSize {0:>7}KiB'
 
173
                   '\tPeakWorking {1:>7}KiB\t{2}').format(
150
174
                   info['WorkingSetSize'] / 1024,
151
175
                   info['PeakWorkingSetSize'] / 1024,
152
 
                   message)
 
176
                   message))
153
177
        return
154
178
    if message:
155
179
        trace.note('%s', message)
156
 
    trace.note('WorkingSize       %8d KB', info['WorkingSetSize'] / 1024)
157
 
    trace.note('PeakWorking       %8d KB', info['PeakWorkingSetSize'] / 1024)
158
 
    trace.note('PagefileUsage     %8d KB', info.get('PagefileUsage', 0) / 1024)
159
 
    trace.note('PeakPagefileUsage %8d KB', info.get('PeakPagefileUsage', 0) / 1024)
160
 
    trace.note('PrivateUsage      %8d KB', info.get('PrivateUsage', 0) / 1024)
161
 
    trace.note('PageFaultCount    %8d', info.get('PageFaultCount', 0))
 
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))
162
187
 
163
188
 
164
189
def get_console_size(defaultx=80, defaulty=25):
173
198
        return (defaultx, defaulty)
174
199
 
175
200
    # To avoid problem with redirecting output via pipe
176
 
    # need to use stderr instead of stdout
 
201
    # we need to use stderr instead of stdout
177
202
    h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
178
203
    csbi = ctypes.create_string_buffer(22)
179
204
    res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
180
205
 
181
206
    if res:
182
207
        (bufx, bufy, curx, cury, wattr,
183
 
        left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
 
208
        left, top, right, bottom, maxx, maxy) = struct.unpack(
 
209
            "hhhhHhhhhhh", csbi.raw)
184
210
        sizex = right - left + 1
185
211
        sizey = bottom - top + 1
186
212
        return (sizex, sizey)
231
257
    one that moves with the user as they logon to different machines, and
232
258
    a 'local' one that stays local to the machine.  This returns the 'roaming'
233
259
    directory, and thus is suitable for storing user-preferences, etc.
234
 
 
235
 
    Returned value can be unicode or plain string.
236
 
    To convert plain string to unicode use
237
 
    s.decode(osutils.get_user_encoding())
238
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
239
260
    """
240
261
    appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
241
262
    if appdata:
242
263
        return appdata
243
 
    # from env variable
244
 
    appdata = os.environ.get('APPDATA')
245
 
    if appdata:
246
 
        return appdata
247
 
    # if we fall to this point we on win98
248
 
    # at least try C:/WINDOWS/Application Data
249
 
    windir = os.environ.get('windir')
250
 
    if windir:
251
 
        appdata = os.path.join(windir, 'Application Data')
252
 
        if os.path.isdir(appdata):
253
 
            return appdata
254
 
    # did not find anything
255
 
    return None
 
264
    # Use APPDATA if defined, will return None if not
 
265
    return get_environ_unicode('APPDATA')
256
266
 
257
267
 
258
268
def get_local_appdata_location():
264
274
    a 'local' one that stays local to the machine.  This returns the 'local'
265
275
    directory, and thus is suitable for caches, temp files and other things
266
276
    which don't need to move with the user.
267
 
 
268
 
    Returned value can be unicode or plain string.
269
 
    To convert plain string to unicode use
270
 
    s.decode(osutils.get_user_encoding())
271
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
272
277
    """
273
278
    local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
274
279
    if local:
275
280
        return local
276
281
    # Vista supplies LOCALAPPDATA, but XP and earlier do not.
277
 
    local = os.environ.get('LOCALAPPDATA')
 
282
    local = get_environ_unicode('LOCALAPPDATA')
278
283
    if local:
279
284
        return local
280
285
    return get_appdata_location()
285
290
    Assume on win32 it's the <My Documents> folder.
286
291
    If location cannot be obtained return system drive root,
287
292
    i.e. C:\
288
 
 
289
 
    Returned value can be unicode or plain string.
290
 
    To convert plain string to unicode use
291
 
    s.decode(osutils.get_user_encoding())
292
293
    """
293
294
    home = _get_sh_special_folder_path(CSIDL_PERSONAL)
294
295
    if home:
295
296
        return home
296
 
    # try for HOME env variable
297
 
    home = os.path.expanduser('~')
298
 
    if home != '~':
 
297
    home = get_environ_unicode('HOME')
 
298
    if home is not None:
299
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)
300
303
    # at least return windows root directory
301
 
    windir = os.environ.get('windir')
 
304
    windir = get_environ_unicode('WINDIR')
302
305
    if windir:
303
306
        return os.path.splitdrive(windir)[0] + '/'
304
307
    # otherwise C:\ is good enough for 98% users
305
 
    return 'C:/'
 
308
    return unicode('C:/')
306
309
 
307
310
 
308
311
def get_user_name():
309
312
    """Return user name as login name.
310
313
    If name cannot be obtained return None.
311
 
 
312
 
    Returned value can be unicode or plain string.
313
 
    To convert plain string to unicode use
314
 
    s.decode(osutils.get_user_encoding())
315
314
    """
316
315
    if has_ctypes:
317
316
        try:
323
322
            buf = create_buffer(UNLEN+1)
324
323
            n = ctypes.c_int(UNLEN+1)
325
324
            if GetUserName(buf, ctypes.byref(n)):
326
 
                return buf.value
 
325
                return extract_buffer(buf)
327
326
    # otherwise try env variables
328
 
    return os.environ.get('USERNAME', None)
 
327
    return get_environ_unicode('USERNAME')
329
328
 
330
329
 
331
330
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
336
335
    """Return host machine name.
337
336
    If name cannot be obtained return None.
338
337
 
339
 
    :return: A unicode string representing the host name. On win98, this may be
340
 
        a plain string as win32 api doesn't support unicode.
 
338
    :return: A unicode string representing the host name.
341
339
    """
342
340
    if has_win32api:
343
341
        try:
360
358
            if (GetComputerNameEx is not None
361
359
                and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
362
360
                                      buf, ctypes.byref(n))):
363
 
                return buf.value
 
361
                return extract_buffer(buf)
364
362
 
365
363
            # Try GetComputerName in case GetComputerNameEx wasn't found
366
364
            # It returns the NETBIOS name, which isn't as good, but still ok.
370
368
                                      None)
371
369
            if (GetComputerName is not None
372
370
                and GetComputerName(buf, ctypes.byref(n))):
373
 
                return buf.value
374
 
    # otherwise try env variables, which will be 'mbcs' encoded
375
 
    # on Windows (Python doesn't expose the native win32 unicode environment)
376
 
    # According to this:
377
 
    # http://msdn.microsoft.com/en-us/library/aa246807.aspx
378
 
    # environment variables should always be encoded in 'mbcs'.
379
 
    try:
380
 
        return os.environ['COMPUTERNAME'].decode("mbcs")
381
 
    except KeyError:
382
 
        return None
383
 
 
384
 
 
 
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)))
385
377
def _ensure_unicode(s):
386
 
    from bzrlib import osutils
387
378
    if s and type(s) != unicode:
388
379
        from bzrlib import osutils
389
380
        s = s.decode(osutils.get_user_encoding())
390
381
    return s
391
382
 
392
383
 
393
 
def get_appdata_location_unicode():
394
 
    return _ensure_unicode(get_appdata_location())
395
 
 
396
 
def get_home_location_unicode():
397
 
    return _ensure_unicode(get_home_location())
398
 
 
399
 
def get_user_name_unicode():
400
 
    return _ensure_unicode(get_user_name())
401
 
 
402
 
def get_host_name_unicode():
403
 
    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)
404
395
 
405
396
 
406
397
def _ensure_with_dir(path):
407
 
    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'?')):
408
400
        return u'./' + path, True
409
401
    else:
410
402
        return path, False
416
408
        return path
417
409
 
418
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
 
419
430
 
420
431
def glob_expand(file_list):
421
432
    """Replacement for glob expansion by the shell.
430
441
    """
431
442
    if not file_list:
432
443
        return []
433
 
    import glob
434
444
    expanded_file_list = []
435
445
    for possible_glob in file_list:
436
 
        # work around bugs in glob.glob()
437
 
        # - Python bug #1001604 ("glob doesn't return unicode with ...")
438
 
        # - failing expansion for */* with non-iso-8859-* chars
439
 
        possible_glob, corrected = _ensure_with_dir(possible_glob)
440
 
        glob_files = glob.glob(possible_glob)
441
 
 
442
 
        if glob_files == []:
443
 
            # special case to let the normal code path handle
444
 
            # files that do not exists
445
 
            expanded_file_list.append(
446
 
                _undo_ensure_with_dir(possible_glob, corrected))
447
 
        else:
448
 
            glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
449
 
            expanded_file_list += glob_files
450
 
 
451
 
    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
452
448
 
453
449
 
454
450
def get_app_path(appname):
455
 
    """Look up in Windows registry for full path to application executable.
 
451
    r"""Look up in Windows registry for full path to application executable.
456
452
    Typically, applications create subkey with their basename
457
453
    in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
458
454
 
462
458
                or appname itself if nothing found.
463
459
    """
464
460
    import _winreg
 
461
 
 
462
    basename = appname
 
463
    if not os.path.splitext(basename)[1]:
 
464
        basename = appname + '.exe'
 
465
 
465
466
    try:
466
467
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
467
 
                               r'SOFTWARE\Microsoft\Windows'
468
 
                               r'\CurrentVersion\App Paths')
 
468
            'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
 
469
            basename)
469
470
    except EnvironmentError:
470
471
        return appname
471
472
 
472
 
    basename = appname
473
 
    if not os.path.splitext(basename)[1]:
474
 
        basename = appname + '.exe'
475
473
    try:
476
474
        try:
477
 
            fullpath = _winreg.QueryValue(hkey, basename)
 
475
            path, type_id = _winreg.QueryValueEx(hkey, '')
478
476
        except WindowsError:
479
 
            fullpath = appname
 
477
            return appname
480
478
    finally:
481
479
        _winreg.CloseKey(hkey)
482
480
 
483
 
    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
484
489
 
485
490
 
486
491
def set_file_attr_hidden(path):
487
492
    """Set file attributes to hidden if possible"""
488
493
    if has_win32file:
489
 
        win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
490
 
 
491
 
 
492
 
if has_ctypes and winver != 'Windows 98':
 
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':
493
547
    def get_unicode_argv():
494
 
        LPCWSTR = ctypes.c_wchar_p
495
 
        INT = ctypes.c_int
496
 
        POINTER = ctypes.POINTER
497
 
        prototype = ctypes.WINFUNCTYPE(LPCWSTR)
498
 
        GetCommandLine = prototype(("GetCommandLineW",
499
 
                                    ctypes.windll.kernel32))
500
 
        prototype = ctypes.WINFUNCTYPE(POINTER(LPCWSTR), LPCWSTR, POINTER(INT))
501
 
        CommandLineToArgv = prototype(("CommandLineToArgvW",
502
 
                                       ctypes.windll.shell32))
503
 
        c = INT(0)
504
 
        pargv = CommandLineToArgv(GetCommandLine(), ctypes.byref(c))
 
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()
505
554
        # Skip the first argument, since we only care about parameters
506
 
        argv = [pargv[i] for i in range(1, c.value)]
507
 
        if getattr(sys, 'frozen', None) is None:
508
 
            # Invoked via 'python.exe' which takes the form:
509
 
            #   python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
510
 
            # we need to get only BZR_OPTIONS part,
511
 
            # so let's using sys.argv[1:] as reference to get the tail
512
 
            # of unicode argv
513
 
            tail_len = len(sys.argv[1:])
514
 
            ix = len(argv) - tail_len
515
 
            argv = argv[ix:]
 
555
        argv = _command_line_to_argv(command_line, sys.argv)[1:]
516
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
517
590
else:
518
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