/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/win32utils.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/win32utils.py
19
19
Only one dependency: ctypes should be installed.
20
20
"""
21
21
 
 
22
from __future__ import absolute_import
 
23
 
22
24
import glob
 
25
import operator
23
26
import os
24
27
import struct
25
28
import sys
26
29
 
27
 
from bzrlib import cmdline
28
 
 
29
 
# Windows version
30
 
if sys.platform == 'win32':
31
 
    _major,_minor,_build,_platform,_text = sys.getwindowsversion()
32
 
    # from MSDN:
33
 
    # dwPlatformId
34
 
    #   The operating system platform.
35
 
    #   This member can be one of the following values.
36
 
    #   ==========================  ======================================
37
 
    #   Value                       Meaning
38
 
    #   --------------------------  --------------------------------------
39
 
    #   VER_PLATFORM_WIN32_NT       The operating system is Windows Vista,
40
 
    #   2                           Windows Server "Longhorn",
41
 
    #                               Windows Server 2003, Windows XP,
42
 
    #                               Windows 2000, or Windows NT.
43
 
    #
44
 
    #   VER_PLATFORM_WIN32_WINDOWS  The operating system is Windows Me,
45
 
    #   1                           Windows 98, or Windows 95.
46
 
    #   ==========================  ======================================
47
 
    if _platform == 2:
48
 
        winver = 'Windows NT'
49
 
    else:
50
 
        # don't care about real Windows name, just to force safe operations
51
 
        winver = 'Windows 98'
52
 
else:
53
 
    winver = None
54
 
 
 
30
from breezy import (
 
31
    cmdline,
 
32
    )
 
33
from breezy.i18n import gettext
55
34
 
56
35
# We can cope without it; use a separate variable to help pyflakes
57
36
try:
60
39
except ImportError:
61
40
    has_ctypes = False
62
41
else:
63
 
    if winver == 'Windows 98':
64
 
        create_buffer = ctypes.create_string_buffer
65
 
        suffix = 'A'
66
 
    else:
67
 
        create_buffer = ctypes.create_unicode_buffer
68
 
        suffix = 'W'
 
42
    create_buffer = ctypes.create_unicode_buffer
 
43
    extract_buffer = operator.attrgetter("value")
 
44
    suffix = 'W'
69
45
try:
70
 
    import win32file
71
46
    import pywintypes
72
 
    has_win32file = True
73
 
except ImportError:
74
 
    has_win32file = False
75
 
try:
76
 
    import win32api
77
 
    has_win32api = True
78
 
except ImportError:
79
 
    has_win32api = False
 
47
    has_pywintypes = True
 
48
except ImportError:
 
49
    has_pywintypes = has_win32file = has_win32api = False
 
50
else:
 
51
    try:
 
52
        import win32file
 
53
        has_win32file = True
 
54
    except ImportError:
 
55
        has_win32file = False
 
56
    try:
 
57
        import win32api
 
58
        has_win32api = True
 
59
    except ImportError:
 
60
        has_win32api = False
80
61
 
81
62
# pulling in win32com.shell is a bit of overhead, and normally we don't need
82
63
# it as ctypes is preferred and common.  lazy_imports and "optional"
106
87
 
107
88
def debug_memory_win32api(message='', short=True):
108
89
    """Use trace.note() to dump the running memory info."""
109
 
    from bzrlib import trace
 
90
    from breezy import trace
110
91
    if has_ctypes:
111
92
        class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
112
93
            """Used by GetProcessMemoryInfo"""
128
109
            ctypes.byref(mem_struct),
129
110
            ctypes.sizeof(mem_struct))
130
111
        if not ret:
131
 
            trace.note('Failed to GetProcessMemoryInfo()')
 
112
            trace.note(gettext('Failed to GetProcessMemoryInfo()'))
132
113
            return
133
114
        info = {'PageFaultCount': mem_struct.PageFaultCount,
134
115
                'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
149
130
        proc = win32process.GetCurrentProcess()
150
131
        info = win32process.GetProcessMemoryInfo(proc)
151
132
    else:
152
 
        trace.note('Cannot debug memory on win32 without ctypes'
153
 
                   ' or win32process')
 
133
        trace.note(gettext('Cannot debug memory on win32 without ctypes'
 
134
                   ' or win32process'))
154
135
        return
155
136
    if short:
156
137
        # using base-2 units (see HACKING.txt).
157
 
        trace.note('WorkingSize %7dKiB'
158
 
                   '\tPeakWorking %7dKiB\t%s',
 
138
        trace.note(gettext('WorkingSize {0:>7}KiB'
 
139
                   '\tPeakWorking {1:>7}KiB\t{2}').format(
159
140
                   info['WorkingSetSize'] / 1024,
160
141
                   info['PeakWorkingSetSize'] / 1024,
161
 
                   message)
 
142
                   message))
162
143
        return
163
144
    if message:
164
145
        trace.note('%s', message)
165
 
    trace.note('WorkingSize       %8d KiB', info['WorkingSetSize'] / 1024)
166
 
    trace.note('PeakWorking       %8d KiB', info['PeakWorkingSetSize'] / 1024)
167
 
    trace.note('PagefileUsage     %8d KiB', info.get('PagefileUsage', 0) / 1024)
168
 
    trace.note('PeakPagefileUsage %8d KiB',
 
146
    trace.note(gettext('WorkingSize       %8d KiB'), info['WorkingSetSize'] / 1024)
 
147
    trace.note(gettext('PeakWorking       %8d KiB'), info['PeakWorkingSetSize'] / 1024)
 
148
    trace.note(gettext('PagefileUsage     %8d KiB'), info.get('PagefileUsage', 0) / 1024)
 
149
    trace.note(gettext('PeakPagefileUsage %8d KiB'),
169
150
               info.get('PeakPagefileUsage', 0) / 1024)
170
 
    trace.note('PrivateUsage      %8d KiB', info.get('PrivateUsage', 0) / 1024)
171
 
    trace.note('PageFaultCount    %8d', info.get('PageFaultCount', 0))
 
151
    trace.note(gettext('PrivateUsage      %8d KiB'), info.get('PrivateUsage', 0) / 1024)
 
152
    trace.note(gettext('PageFaultCount    %8d'), info.get('PageFaultCount', 0))
172
153
 
173
154
 
174
155
def get_console_size(defaultx=80, defaulty=25):
242
223
    one that moves with the user as they logon to different machines, and
243
224
    a 'local' one that stays local to the machine.  This returns the 'roaming'
244
225
    directory, and thus is suitable for storing user-preferences, etc.
245
 
 
246
 
    Returned value can be unicode or plain string.
247
 
    To convert plain string to unicode use
248
 
    s.decode(osutils.get_user_encoding())
249
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
250
226
    """
251
227
    appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
252
228
    if appdata:
253
229
        return appdata
254
 
    # from env variable
255
 
    appdata = os.environ.get('APPDATA')
256
 
    if appdata:
257
 
        return appdata
258
 
    # if we fall to this point we on win98
259
 
    # at least try C:/WINDOWS/Application Data
260
 
    windir = os.environ.get('windir')
261
 
    if windir:
262
 
        appdata = os.path.join(windir, 'Application Data')
263
 
        if os.path.isdir(appdata):
264
 
            return appdata
265
 
    # did not find anything
266
 
    return None
 
230
    # Use APPDATA if defined, will return None if not
 
231
    return get_environ_unicode('APPDATA')
267
232
 
268
233
 
269
234
def get_local_appdata_location():
275
240
    a 'local' one that stays local to the machine.  This returns the 'local'
276
241
    directory, and thus is suitable for caches, temp files and other things
277
242
    which don't need to move with the user.
278
 
 
279
 
    Returned value can be unicode or plain string.
280
 
    To convert plain string to unicode use
281
 
    s.decode(osutils.get_user_encoding())
282
 
    (XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
283
243
    """
284
244
    local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
285
245
    if local:
286
246
        return local
287
247
    # Vista supplies LOCALAPPDATA, but XP and earlier do not.
288
 
    local = os.environ.get('LOCALAPPDATA')
 
248
    local = get_environ_unicode('LOCALAPPDATA')
289
249
    if local:
290
250
        return local
291
251
    return get_appdata_location()
296
256
    Assume on win32 it's the <My Documents> folder.
297
257
    If location cannot be obtained return system drive root,
298
258
    i.e. C:\
299
 
 
300
 
    Returned value can be unicode or plain string.
301
 
    To convert plain string to unicode use
302
 
    s.decode(osutils.get_user_encoding())
303
259
    """
304
260
    home = _get_sh_special_folder_path(CSIDL_PERSONAL)
305
261
    if home:
306
262
        return home
307
 
    # try for HOME env variable
308
 
    home = os.path.expanduser('~')
309
 
    if home != '~':
 
263
    home = get_environ_unicode('HOME')
 
264
    if home is not None:
310
265
        return home
 
266
    homepath = get_environ_unicode('HOMEPATH')
 
267
    if homepath is not None:
 
268
        return os.path.join(get_environ_unicode('HOMEDIR', ''), home)
311
269
    # at least return windows root directory
312
 
    windir = os.environ.get('windir')
 
270
    windir = get_environ_unicode('WINDIR')
313
271
    if windir:
314
272
        return os.path.splitdrive(windir)[0] + '/'
315
273
    # otherwise C:\ is good enough for 98% users
316
 
    return 'C:/'
 
274
    return unicode('C:/')
317
275
 
318
276
 
319
277
def get_user_name():
320
278
    """Return user name as login name.
321
279
    If name cannot be obtained return None.
322
 
 
323
 
    Returned value can be unicode or plain string.
324
 
    To convert plain string to unicode use
325
 
    s.decode(osutils.get_user_encoding())
326
280
    """
327
281
    if has_ctypes:
328
282
        try:
334
288
            buf = create_buffer(UNLEN+1)
335
289
            n = ctypes.c_int(UNLEN+1)
336
290
            if GetUserName(buf, ctypes.byref(n)):
337
 
                return buf.value
 
291
                return extract_buffer(buf)
338
292
    # otherwise try env variables
339
 
    return os.environ.get('USERNAME', None)
 
293
    return get_environ_unicode('USERNAME')
340
294
 
341
295
 
342
296
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
347
301
    """Return host machine name.
348
302
    If name cannot be obtained return None.
349
303
 
350
 
    :return: A unicode string representing the host name. On win98, this may be
351
 
        a plain string as win32 api doesn't support unicode.
 
304
    :return: A unicode string representing the host name.
352
305
    """
353
306
    if has_win32api:
354
307
        try:
371
324
            if (GetComputerNameEx is not None
372
325
                and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
373
326
                                      buf, ctypes.byref(n))):
374
 
                return buf.value
 
327
                return extract_buffer(buf)
375
328
 
376
329
            # Try GetComputerName in case GetComputerNameEx wasn't found
377
330
            # It returns the NETBIOS name, which isn't as good, but still ok.
381
334
                                      None)
382
335
            if (GetComputerName is not None
383
336
                and GetComputerName(buf, ctypes.byref(n))):
384
 
                return buf.value
385
 
    # otherwise try env variables, which will be 'mbcs' encoded
386
 
    # on Windows (Python doesn't expose the native win32 unicode environment)
387
 
    # According to this:
388
 
    # http://msdn.microsoft.com/en-us/library/aa246807.aspx
389
 
    # environment variables should always be encoded in 'mbcs'.
390
 
    try:
391
 
        return os.environ['COMPUTERNAME'].decode("mbcs")
392
 
    except KeyError:
393
 
        return None
394
 
 
395
 
 
396
 
def _ensure_unicode(s):
397
 
    if s and type(s) != unicode:
398
 
        from bzrlib import osutils
399
 
        s = s.decode(osutils.get_user_encoding())
400
 
    return s
401
 
 
402
 
 
403
 
def get_appdata_location_unicode():
404
 
    return _ensure_unicode(get_appdata_location())
405
 
 
406
 
def get_home_location_unicode():
407
 
    return _ensure_unicode(get_home_location())
408
 
 
409
 
def get_user_name_unicode():
410
 
    return _ensure_unicode(get_user_name())
411
 
 
412
 
def get_host_name_unicode():
413
 
    return _ensure_unicode(get_host_name())
 
337
                return extract_buffer(buf)
 
338
    return get_environ_unicode('COMPUTERNAME')
414
339
 
415
340
 
416
341
def _ensure_with_dir(path):
427
352
        return path
428
353
 
429
354
 
430
 
 
431
355
def glob_one(possible_glob):
432
356
    """Same as glob.glob().
433
357
 
457
381
    :param file_list: A list of filenames which may include shell globs.
458
382
    :return: An expanded list of filenames.
459
383
 
460
 
    Introduced in bzrlib 0.18.
 
384
    Introduced in breezy 0.18.
461
385
    """
462
386
    if not file_list:
463
387
        return []
468
392
 
469
393
 
470
394
def get_app_path(appname):
471
 
    """Look up in Windows registry for full path to application executable.
 
395
    r"""Look up in Windows registry for full path to application executable.
472
396
    Typically, applications create subkey with their basename
473
397
    in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
474
398
 
511
435
def set_file_attr_hidden(path):
512
436
    """Set file attributes to hidden if possible"""
513
437
    if has_win32file:
514
 
        if winver != 'Windows 98':
515
 
            SetFileAttributes = win32file.SetFileAttributesW
516
 
        else:
517
 
            SetFileAttributes = win32file.SetFileAttributes
 
438
        SetFileAttributes = win32file.SetFileAttributesW
518
439
        try:
519
440
            SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
520
 
        except pywintypes.error, e:
521
 
            from bzrlib import trace
 
441
        except pywintypes.error as e:
 
442
            from . import trace
522
443
            trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
523
444
 
524
445
 
525
 
def _command_line_to_argv(command_line, single_quotes_allowed=False):
 
446
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
526
447
    """Convert a Unicode command line into a list of argv arguments.
527
448
 
528
449
    It performs wildcard expansion to make wildcards act closer to how they
535
456
                                  default.
536
457
    :return: A list of unicode strings.
537
458
    """
 
459
    # First, split the command line
538
460
    s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
539
 
    # Now that we've split the content, expand globs if necessary
 
461
    
 
462
    # Bug #587868 Now make sure that the length of s agrees with sys.argv 
 
463
    # we do this by simply counting the number of arguments in each. The counts should 
 
464
    # agree no matter what encoding sys.argv is in (AFAIK) 
 
465
    # len(arguments) < len(sys.argv) should be an impossibility since python gets 
 
466
    # args from the very same PEB as does GetCommandLineW
 
467
    arguments = list(s)
 
468
    
 
469
    # Now shorten the command line we get from GetCommandLineW to match sys.argv
 
470
    if len(arguments) < len(argv):
 
471
        raise AssertionError("Split command line can't be shorter than argv")
 
472
    arguments = arguments[len(arguments) - len(argv):]
 
473
    
 
474
    # Carry on to process globs (metachars) in the command line
 
475
    # expand globs if necessary
540
476
    # TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
541
477
    #       '**/' style globs
542
478
    args = []
543
 
    for is_quoted, arg in s:
 
479
    for is_quoted, arg in arguments:
544
480
        if is_quoted or not glob.has_magic(arg):
545
481
            args.append(arg)
546
482
        else:
548
484
    return args
549
485
 
550
486
 
551
 
if has_ctypes and winver != 'Windows 98':
 
487
if has_ctypes:
552
488
    def get_unicode_argv():
553
489
        prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
554
490
        GetCommandLineW = prototype(("GetCommandLineW",
557
493
        if command_line is None:
558
494
            raise ctypes.WinError()
559
495
        # Skip the first argument, since we only care about parameters
560
 
        argv = _command_line_to_argv(command_line)[1:]
561
 
        if getattr(sys, 'frozen', None) is None:
562
 
            # Invoked via 'python.exe' which takes the form:
563
 
            #   python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
564
 
            # we need to get only BZR_OPTIONS part,
565
 
            # We already removed 'python.exe' so we remove everything up to and
566
 
            # including the first non-option ('-') argument.
567
 
            for idx in xrange(len(argv)):
568
 
                if argv[idx][:1] != '-':
569
 
                    break
570
 
            argv = argv[idx+1:]
 
496
        argv = _command_line_to_argv(command_line, sys.argv)[1:]
571
497
        return argv
572
 
else:
573
 
    get_unicode_argv = None
 
498
 
 
499
 
 
500
    def get_environ_unicode(key, default=None):
 
501
        """Get `key` from environment as unicode or `default` if unset
 
502
 
 
503
        The environment is natively unicode on modern windows versions but
 
504
        Python 2 only accesses it through the legacy bytestring api.
 
505
 
 
506
        Environmental variable names are case insenstive on Windows.
 
507
 
 
508
        A large enough buffer will be allocated to retrieve the value, though
 
509
        it may take two calls to the underlying library function.
 
510
 
 
511
        This needs ctypes because pywin32 does not expose the wide version.
 
512
        """
 
513
        cfunc = getattr(get_environ_unicode, "_c_function", None)
 
514
        if cfunc is None:
 
515
            from ctypes.wintypes import DWORD, LPCWSTR, LPWSTR
 
516
            cfunc = ctypes.WINFUNCTYPE(DWORD, LPCWSTR, LPWSTR, DWORD)(
 
517
                ("GetEnvironmentVariableW", ctypes.windll.kernel32))
 
518
            get_environ_unicode._c_function = cfunc
 
519
        buffer_size = 256 # heuristic, 256 characters often enough
 
520
        while True:
 
521
            buffer = ctypes.create_unicode_buffer(buffer_size)
 
522
            length = cfunc(key, buffer, buffer_size)
 
523
            if not length:
 
524
                code = ctypes.GetLastError()
 
525
                if code == 203: # ERROR_ENVVAR_NOT_FOUND
 
526
                    return default
 
527
                raise ctypes.WinError(code)
 
528
            if buffer_size > length:
 
529
                return buffer[:length]
 
530
            buffer_size = length
 
531
 
 
532
 
 
533
if has_win32api:
 
534
    def _pywin32_is_local_pid_dead(pid):
 
535
        """True if pid doesn't correspond to live process on this machine"""
 
536
        try:
 
537
            handle = win32api.OpenProcess(1, False, pid) # PROCESS_TERMINATE
 
538
        except pywintypes.error as e:
 
539
            if e[0] == 5: # ERROR_ACCESS_DENIED
 
540
                # Probably something alive we're not allowed to kill
 
541
                return False
 
542
            elif e[0] == 87: # ERROR_INVALID_PARAMETER
 
543
                return True
 
544
            raise
 
545
        handle.close()
 
546
        return False
 
547
    is_local_pid_dead = _pywin32_is_local_pid_dead
 
548
elif has_ctypes and sys.platform == 'win32':
 
549
    from ctypes.wintypes import BOOL, DWORD, HANDLE
 
550
    _kernel32 = ctypes.windll.kernel32
 
551
    _CloseHandle = ctypes.WINFUNCTYPE(BOOL, HANDLE)(
 
552
        ("CloseHandle", _kernel32))
 
553
    _OpenProcess = ctypes.WINFUNCTYPE(HANDLE, DWORD, BOOL, DWORD)(
 
554
        ("OpenProcess", _kernel32))
 
555
    def _ctypes_is_local_pid_dead(pid):
 
556
        """True if pid doesn't correspond to live process on this machine"""
 
557
        handle = _OpenProcess(1, False, pid) # PROCESS_TERMINATE
 
558
        if not handle:
 
559
            errorcode = ctypes.GetLastError()
 
560
            if errorcode == 5: # ERROR_ACCESS_DENIED
 
561
                # Probably something alive we're not allowed to kill
 
562
                return False
 
563
            elif errorcode == 87: # ERROR_INVALID_PARAMETER
 
564
                return True
 
565
            raise ctypes.WinError(errorcode)
 
566
        _CloseHandle(handle)
 
567
        return False
 
568
    is_local_pid_dead = _ctypes_is_local_pid_dead
 
569
 
 
570
 
 
571
def _is_pywintypes_error(evalue):
 
572
    """True if exception instance is an error from pywin32"""
 
573
    if has_pywintypes and isinstance(evalue, pywintypes.error):
 
574
        return True
 
575
    return False