~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/win32utils.py

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
import glob
23
22
import os
24
23
import struct
25
24
import sys
26
25
 
27
 
from bzrlib import cmdline
28
26
 
29
27
# Windows version
30
28
if sys.platform == 'win32':
68
66
        suffix = 'W'
69
67
try:
70
68
    import win32file
71
 
    import pywintypes
72
69
    has_win32file = True
73
70
except ImportError:
74
71
    has_win32file = False
78
75
except ImportError:
79
76
    has_win32api = False
80
77
 
81
 
# pulling in win32com.shell is a bit of overhead, and normally we don't need
82
 
# it as ctypes is preferred and common.  lazy_imports and "optional"
83
 
# modules don't work well, so we do our own lazy thing...
84
 
has_win32com_shell = None # Set to True or False once we know for sure...
85
78
 
86
79
# Special Win32 API constants
87
80
# Handles of std streams
91
84
 
92
85
# CSIDL constants (from MSDN 2003)
93
86
CSIDL_APPDATA = 0x001A      # Application Data folder
94
 
CSIDL_LOCAL_APPDATA = 0x001c# <user name>\Local Settings\Application Data (non roaming)
95
87
CSIDL_PERSONAL = 0x0005     # My Documents folder
96
88
 
97
89
# from winapi C headers
99
91
UNLEN = 256
100
92
MAX_COMPUTERNAME_LENGTH = 31
101
93
 
102
 
# Registry data type ids
103
 
REG_SZ = 1
104
 
REG_EXPAND_SZ = 2
105
 
 
106
 
 
107
 
def debug_memory_win32api(message='', short=True):
108
 
    """Use trace.note() to dump the running memory info."""
109
 
    from bzrlib import trace
110
 
    if has_ctypes:
111
 
        class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
112
 
            """Used by GetProcessMemoryInfo"""
113
 
            _fields_ = [('cb', ctypes.c_ulong),
114
 
                        ('PageFaultCount', ctypes.c_ulong),
115
 
                        ('PeakWorkingSetSize', ctypes.c_size_t),
116
 
                        ('WorkingSetSize', ctypes.c_size_t),
117
 
                        ('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
118
 
                        ('QuotaPagedPoolUsage', ctypes.c_size_t),
119
 
                        ('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
120
 
                        ('QuotaNonPagedPoolUsage', ctypes.c_size_t),
121
 
                        ('PagefileUsage', ctypes.c_size_t),
122
 
                        ('PeakPagefileUsage', ctypes.c_size_t),
123
 
                        ('PrivateUsage', ctypes.c_size_t),
124
 
                       ]
125
 
        cur_process = ctypes.windll.kernel32.GetCurrentProcess()
126
 
        mem_struct = PROCESS_MEMORY_COUNTERS_EX()
127
 
        ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
128
 
            ctypes.byref(mem_struct),
129
 
            ctypes.sizeof(mem_struct))
130
 
        if not ret:
131
 
            trace.note('Failed to GetProcessMemoryInfo()')
132
 
            return
133
 
        info = {'PageFaultCount': mem_struct.PageFaultCount,
134
 
                'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
135
 
                'WorkingSetSize': mem_struct.WorkingSetSize,
136
 
                'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
137
 
                'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
138
 
                'QuotaPeakNonPagedPoolUsage':
139
 
                    mem_struct.QuotaPeakNonPagedPoolUsage,
140
 
                'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
141
 
                'PagefileUsage': mem_struct.PagefileUsage,
142
 
                'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
143
 
                'PrivateUsage': mem_struct.PrivateUsage,
144
 
               }
145
 
    elif has_win32api:
146
 
        import win32process
147
 
        # win32process does not return PrivateUsage, because it doesn't use
148
 
        # PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
149
 
        proc = win32process.GetCurrentProcess()
150
 
        info = win32process.GetProcessMemoryInfo(proc)
151
 
    else:
152
 
        trace.note('Cannot debug memory on win32 without ctypes'
153
 
                   ' or win32process')
154
 
        return
155
 
    if short:
156
 
        # using base-2 units (see HACKING.txt).
157
 
        trace.note('WorkingSize %7dKiB'
158
 
                   '\tPeakWorking %7dKiB\t%s',
159
 
                   info['WorkingSetSize'] / 1024,
160
 
                   info['PeakWorkingSetSize'] / 1024,
161
 
                   message)
162
 
        return
163
 
    if message:
164
 
        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',
169
 
               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))
172
 
 
173
94
 
174
95
def get_console_size(defaultx=80, defaulty=25):
175
96
    """Return size of current console.
183
104
        return (defaultx, defaulty)
184
105
 
185
106
    # To avoid problem with redirecting output via pipe
186
 
    # we need to use stderr instead of stdout
 
107
    # need to use stderr instead of stdout
187
108
    h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
188
109
    csbi = ctypes.create_string_buffer(22)
189
110
    res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
190
111
 
191
112
    if res:
192
113
        (bufx, bufy, curx, cury, wattr,
193
 
        left, top, right, bottom, maxx, maxy) = struct.unpack(
194
 
            "hhhhHhhhhhh", csbi.raw)
 
114
        left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
195
115
        sizex = right - left + 1
196
116
        sizey = bottom - top + 1
197
117
        return (sizex, sizey)
199
119
        return (defaultx, defaulty)
200
120
 
201
121
 
202
 
def _get_sh_special_folder_path(csidl):
203
 
    """Call SHGetSpecialFolderPathW if available, or return None.
204
 
 
205
 
    Result is always unicode (or None).
206
 
    """
207
 
    if has_ctypes:
208
 
        try:
209
 
            SHGetSpecialFolderPath = \
210
 
                ctypes.windll.shell32.SHGetSpecialFolderPathW
211
 
        except AttributeError:
212
 
            pass
213
 
        else:
214
 
            buf = ctypes.create_unicode_buffer(MAX_PATH)
215
 
            if SHGetSpecialFolderPath(None,buf,csidl,0):
216
 
                return buf.value
217
 
 
218
 
    global has_win32com_shell
219
 
    if has_win32com_shell is None:
220
 
        try:
221
 
            from win32com.shell import shell
222
 
            has_win32com_shell = True
223
 
        except ImportError:
224
 
            has_win32com_shell = False
225
 
    if has_win32com_shell:
226
 
        # still need to bind the name locally, but this is fast.
227
 
        from win32com.shell import shell
228
 
        try:
229
 
            return shell.SHGetSpecialFolderPath(0, csidl, 0)
230
 
        except shell.error:
231
 
            # possibly E_NOTIMPL meaning we can't load the function pointer,
232
 
            # or E_FAIL meaning the function failed - regardless, just ignore it
233
 
            pass
234
 
    return None
235
 
 
236
 
 
237
122
def get_appdata_location():
238
123
    """Return Application Data location.
239
124
    Return None if we cannot obtain location.
240
125
 
241
 
    Windows defines two 'Application Data' folders per user - a 'roaming'
242
 
    one that moves with the user as they logon to different machines, and
243
 
    a 'local' one that stays local to the machine.  This returns the 'roaming'
244
 
    directory, and thus is suitable for storing user-preferences, etc.
245
 
 
246
 
    Returned value can be unicode or plain string.
 
126
    Returned value can be unicode or plain sring.
247
127
    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')
 
128
    s.decode(bzrlib.user_encoding)
250
129
    """
251
 
    appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
252
 
    if appdata:
253
 
        return appdata
 
130
    if has_ctypes:
 
131
        try:
 
132
            SHGetSpecialFolderPath = \
 
133
                ctypes.windll.shell32.SHGetSpecialFolderPathW
 
134
        except AttributeError:
 
135
            pass
 
136
        else:
 
137
            buf = ctypes.create_unicode_buffer(MAX_PATH)
 
138
            if SHGetSpecialFolderPath(None,buf,CSIDL_APPDATA,0):
 
139
                return buf.value
254
140
    # from env variable
255
141
    appdata = os.environ.get('APPDATA')
256
142
    if appdata:
266
152
    return None
267
153
 
268
154
 
269
 
def get_local_appdata_location():
270
 
    """Return Local Application Data location.
271
 
    Return the same as get_appdata_location() if we cannot obtain location.
272
 
 
273
 
    Windows defines two 'Application Data' folders per user - a 'roaming'
274
 
    one that moves with the user as they logon to different machines, and
275
 
    a 'local' one that stays local to the machine.  This returns the 'local'
276
 
    directory, and thus is suitable for caches, temp files and other things
277
 
    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
 
    """
284
 
    local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
285
 
    if local:
286
 
        return local
287
 
    # Vista supplies LOCALAPPDATA, but XP and earlier do not.
288
 
    local = os.environ.get('LOCALAPPDATA')
289
 
    if local:
290
 
        return local
291
 
    return get_appdata_location()
292
 
 
293
 
 
294
155
def get_home_location():
295
156
    """Return user's home location.
296
157
    Assume on win32 it's the <My Documents> folder.
297
158
    If location cannot be obtained return system drive root,
298
159
    i.e. C:\
299
160
 
300
 
    Returned value can be unicode or plain string.
 
161
    Returned value can be unicode or plain sring.
301
162
    To convert plain string to unicode use
302
 
    s.decode(osutils.get_user_encoding())
 
163
    s.decode(bzrlib.user_encoding)
303
164
    """
304
 
    home = _get_sh_special_folder_path(CSIDL_PERSONAL)
305
 
    if home:
306
 
        return home
 
165
    if has_ctypes:
 
166
        try:
 
167
            SHGetSpecialFolderPath = \
 
168
                ctypes.windll.shell32.SHGetSpecialFolderPathW
 
169
        except AttributeError:
 
170
            pass
 
171
        else:
 
172
            buf = ctypes.create_unicode_buffer(MAX_PATH)
 
173
            if SHGetSpecialFolderPath(None,buf,CSIDL_PERSONAL,0):
 
174
                return buf.value
307
175
    # try for HOME env variable
308
176
    home = os.path.expanduser('~')
309
177
    if home != '~':
320
188
    """Return user name as login name.
321
189
    If name cannot be obtained return None.
322
190
 
323
 
    Returned value can be unicode or plain string.
 
191
    Returned value can be unicode or plain sring.
324
192
    To convert plain string to unicode use
325
 
    s.decode(osutils.get_user_encoding())
 
193
    s.decode(bzrlib.user_encoding)
326
194
    """
327
195
    if has_ctypes:
328
196
        try:
395
263
 
396
264
def _ensure_unicode(s):
397
265
    if s and type(s) != unicode:
398
 
        from bzrlib import osutils
399
 
        s = s.decode(osutils.get_user_encoding())
 
266
        import bzrlib
 
267
        s = s.decode(bzrlib.user_encoding)
400
268
    return s
401
269
 
402
270
 
414
282
 
415
283
 
416
284
def _ensure_with_dir(path):
417
 
    if (not os.path.split(path)[0] or path.startswith(u'*')
418
 
        or path.startswith(u'?')):
 
285
    if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
419
286
        return u'./' + path, True
420
287
    else:
421
288
        return path, False
422
 
 
 
289
    
423
290
def _undo_ensure_with_dir(path, corrected):
424
291
    if corrected:
425
292
        return path[2:]
428
295
 
429
296
 
430
297
 
431
 
def glob_one(possible_glob):
432
 
    """Same as glob.glob().
433
 
 
434
 
    work around bugs in glob.glob()
435
 
    - Python bug #1001604 ("glob doesn't return unicode with ...")
436
 
    - failing expansion for */* with non-iso-8859-* chars
437
 
    """
438
 
    corrected_glob, corrected = _ensure_with_dir(possible_glob)
439
 
    glob_files = glob.glob(corrected_glob)
440
 
 
441
 
    if not glob_files:
442
 
        # special case to let the normal code path handle
443
 
        # files that do not exist, etc.
444
 
        glob_files = [possible_glob]
445
 
    elif corrected:
446
 
        glob_files = [_undo_ensure_with_dir(elem, corrected)
447
 
                      for elem in glob_files]
448
 
    return [elem.replace(u'\\', u'/') for elem in glob_files]
449
 
 
450
 
 
451
298
def glob_expand(file_list):
452
299
    """Replacement for glob expansion by the shell.
453
300
 
461
308
    """
462
309
    if not file_list:
463
310
        return []
 
311
    import glob
464
312
    expanded_file_list = []
465
313
    for possible_glob in file_list:
466
 
        expanded_file_list.extend(glob_one(possible_glob))
467
 
    return expanded_file_list
 
314
        
 
315
        # work around bugs in glob.glob()
 
316
        # - Python bug #1001604 ("glob doesn't return unicode with ...")
 
317
        # - failing expansion for */* with non-iso-8859-* chars
 
318
        possible_glob, corrected = _ensure_with_dir(possible_glob)
 
319
        glob_files = glob.glob(possible_glob)
 
320
 
 
321
        if glob_files == []:
 
322
            # special case to let the normal code path handle
 
323
            # files that do not exists
 
324
            expanded_file_list.append(
 
325
                _undo_ensure_with_dir(possible_glob, corrected))
 
326
        else:
 
327
            glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
 
328
            expanded_file_list += glob_files
 
329
            
 
330
    return [elem.replace(u'\\', u'/') for elem in expanded_file_list] 
468
331
 
469
332
 
470
333
def get_app_path(appname):
471
 
    r"""Look up in Windows registry for full path to application executable.
472
 
    Typically, applications create subkey with their basename
 
334
    """Look up in Windows registry for full path to application executable.
 
335
    Typicaly, applications create subkey with their basename
473
336
    in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
474
337
 
475
338
    :param  appname:    name of application (if no filename extension
478
341
                or appname itself if nothing found.
479
342
    """
480
343
    import _winreg
 
344
    try:
 
345
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
 
346
                               r'SOFTWARE\Microsoft\Windows'
 
347
                               r'\CurrentVersion\App Paths')
 
348
    except EnvironmentError:
 
349
        return appname
481
350
 
482
351
    basename = appname
483
352
    if not os.path.splitext(basename)[1]:
484
353
        basename = appname + '.exe'
485
 
 
486
 
    try:
487
 
        hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
488
 
            'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
489
 
            basename)
490
 
    except EnvironmentError:
491
 
        return appname
492
 
 
493
354
    try:
494
355
        try:
495
 
            path, type_id = _winreg.QueryValueEx(hkey, '')
 
356
            fullpath = _winreg.QueryValue(hkey, basename)
496
357
        except WindowsError:
497
 
            return appname
 
358
            fullpath = appname
498
359
    finally:
499
360
        _winreg.CloseKey(hkey)
500
361
 
501
 
    if type_id == REG_SZ:
502
 
        return path
503
 
    if type_id == REG_EXPAND_SZ and has_win32api:
504
 
        fullpath = win32api.ExpandEnvironmentStrings(path)
505
 
        if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
506
 
            fullpath = fullpath[1:-1]   # remove quotes around value
507
 
        return fullpath
508
 
    return appname
 
362
    return fullpath
509
363
 
510
364
 
511
365
def set_file_attr_hidden(path):
512
366
    """Set file attributes to hidden if possible"""
513
367
    if has_win32file:
514
 
        if winver != 'Windows 98':
515
 
            SetFileAttributes = win32file.SetFileAttributesW
516
 
        else:
517
 
            SetFileAttributes = win32file.SetFileAttributes
518
 
        try:
519
 
            SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
520
 
        except pywintypes.error, e:
521
 
            from bzrlib import trace
522
 
            trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
523
 
 
524
 
 
525
 
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
526
 
    """Convert a Unicode command line into a list of argv arguments.
527
 
 
528
 
    It performs wildcard expansion to make wildcards act closer to how they
529
 
    work in posix shells, versus how they work by default on Windows. Quoted
530
 
    arguments are left untouched.
531
 
 
532
 
    :param command_line: The unicode string to split into an arg list.
533
 
    :param single_quotes_allowed: Whether single quotes are accepted as quoting
534
 
                                  characters like double quotes. False by
535
 
                                  default.
536
 
    :return: A list of unicode strings.
537
 
    """
538
 
    # First, spit the command line
539
 
    s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
540
 
    
541
 
    # Bug #587868 Now make sure that the length of s agrees with sys.argv 
542
 
    # we do this by simply counting the number of arguments in each. The counts should 
543
 
    # agree no matter what encoding sys.argv is in (AFAIK) 
544
 
    # len(arguments) < len(sys.argv) should be an impossibility since python gets 
545
 
    # args from the very same PEB as does GetCommandLineW
546
 
    arguments = list(s)
547
 
    
548
 
    # Now shorten the command line we get from GetCommandLineW to match sys.argv
549
 
    if len(arguments) < len(argv):
550
 
        raise AssertionError("Split command line can't be shorter than argv")
551
 
    arguments = arguments[len(arguments) - len(argv):]
552
 
    
553
 
    # Carry on to process globs (metachars) in the command line
554
 
    # expand globs if necessary
555
 
    # TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
556
 
    #       '**/' style globs
557
 
    args = []
558
 
    for is_quoted, arg in arguments:
559
 
        if is_quoted or not glob.has_magic(arg):
560
 
            args.append(arg)
561
 
        else:
562
 
            args.extend(glob_one(arg))
563
 
    return args
564
 
 
565
 
 
566
 
if has_ctypes and winver != 'Windows 98':
567
 
    def get_unicode_argv():
568
 
        prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
569
 
        GetCommandLineW = prototype(("GetCommandLineW",
570
 
                                     ctypes.windll.kernel32))
571
 
        command_line = GetCommandLineW()
572
 
        if command_line is None:
573
 
            raise ctypes.WinError()
574
 
        # Skip the first argument, since we only care about parameters
575
 
        argv = _command_line_to_argv(command_line, sys.argv)[1:]
576
 
        return argv
577
 
else:
578
 
    get_unicode_argv = None
579
 
 
580
 
 
581
 
if has_win32api:
582
 
    def _pywin32_is_local_pid_dead(pid):
583
 
        """True if pid doesn't correspond to live process on this machine"""
584
 
        try:
585
 
            handle = win32api.OpenProcess(1, False, pid) # PROCESS_TERMINATE
586
 
        except pywintypes.error, e:
587
 
            if e[0] == 5: # ERROR_ACCESS_DENIED
588
 
                # Probably something alive we're not allowed to kill
589
 
                return False
590
 
            elif e[0] == 87: # ERROR_INVALID_PARAMETER
591
 
                return True
592
 
            raise
593
 
        handle.close()
594
 
        return False
595
 
    is_local_pid_dead = _pywin32_is_local_pid_dead
596
 
elif has_ctypes and sys.platform == 'win32':
597
 
    from ctypes.wintypes import BOOL, DWORD, HANDLE
598
 
    _kernel32 = ctypes.windll.kernel32
599
 
    _CloseHandle = ctypes.WINFUNCTYPE(BOOL, HANDLE)(
600
 
        ("CloseHandle", _kernel32))
601
 
    _OpenProcess = ctypes.WINFUNCTYPE(HANDLE, DWORD, BOOL, DWORD)(
602
 
        ("OpenProcess", _kernel32))
603
 
    def _ctypes_is_local_pid_dead(pid):
604
 
        """True if pid doesn't correspond to live process on this machine"""
605
 
        handle = _OpenProcess(1, False, pid) # PROCESS_TERMINATE
606
 
        if not handle:
607
 
            errorcode = ctypes.GetLastError()
608
 
            if errorcode == 5: # ERROR_ACCESS_DENIED
609
 
                # Probably something alive we're not allowed to kill
610
 
                return False
611
 
            elif errorcode == 87: # ERROR_INVALID_PARAMETER
612
 
                return True
613
 
            raise ctypes.WinError(errorcode)
614
 
        _CloseHandle(handle)
615
 
        return False
616
 
    is_local_pid_dead = _ctypes_is_local_pid_dead
 
368
        win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)