115
82
MAX_COMPUTERNAME_LENGTH = 31
117
# Registry data type ids
122
def debug_memory_win32api(message='', short=True):
123
"""Use trace.note() to dump the running memory info."""
124
from bzrlib import trace
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),
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))
146
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
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,
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)
167
trace.note(gettext('Cannot debug memory on win32 without ctypes'
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,
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))
189
85
def get_console_size(defaultx=80, defaulty=25):
190
86
"""Return size of current console.
214
109
return (defaultx, defaulty)
217
def _get_sh_special_folder_path(csidl):
218
"""Call SHGetSpecialFolderPathW if available, or return None.
220
Result is always unicode (or None).
224
SHGetSpecialFolderPath = \
225
ctypes.windll.shell32.SHGetSpecialFolderPathW
226
except AttributeError:
229
buf = ctypes.create_unicode_buffer(MAX_PATH)
230
if SHGetSpecialFolderPath(None,buf,csidl,0):
233
global has_win32com_shell
234
if has_win32com_shell is None:
236
from win32com.shell import shell
237
has_win32com_shell = True
239
has_win32com_shell = False
240
if has_win32com_shell:
241
# still need to bind the name locally, but this is fast.
242
from win32com.shell import shell
244
return shell.SHGetSpecialFolderPath(0, csidl, 0)
246
# possibly E_NOTIMPL meaning we can't load the function pointer,
247
# or E_FAIL meaning the function failed - regardless, just ignore it
252
112
def get_appdata_location():
253
113
"""Return Application Data location.
254
114
Return None if we cannot obtain location.
256
Windows defines two 'Application Data' folders per user - a 'roaming'
257
one that moves with the user as they logon to different machines, and
258
a 'local' one that stays local to the machine. This returns the 'roaming'
259
directory, and thus is suitable for storing user-preferences, etc.
116
Returned value can be unicode or plain sring.
117
To convert plain string to unicode use
118
s.decode(bzrlib.user_encoding)
261
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
122
SHGetSpecialFolderPath = \
123
ctypes.windll.shell32.SHGetSpecialFolderPathW
124
except AttributeError:
127
buf = ctypes.create_unicode_buffer(MAX_PATH)
128
if SHGetSpecialFolderPath(None,buf,CSIDL_APPDATA,0):
131
appdata = os.environ.get('APPDATA')
264
# Use APPDATA if defined, will return None if not
265
return get_environ_unicode('APPDATA')
268
def get_local_appdata_location():
269
"""Return Local Application Data location.
270
Return the same as get_appdata_location() if we cannot obtain location.
272
Windows defines two 'Application Data' folders per user - a 'roaming'
273
one that moves with the user as they logon to different machines, and
274
a 'local' one that stays local to the machine. This returns the 'local'
275
directory, and thus is suitable for caches, temp files and other things
276
which don't need to move with the user.
278
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
281
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
282
local = get_environ_unicode('LOCALAPPDATA')
285
return get_appdata_location()
134
# if we fall to this point we on win98
135
# at least try C:/WINDOWS/Application Data
136
windir = os.environ.get('windir')
138
appdata = os.path.join(windir, 'Application Data')
139
if os.path.isdir(appdata):
141
# did not find anything
288
145
def get_home_location():
290
147
Assume on win32 it's the <My Documents> folder.
291
148
If location cannot be obtained return system drive root,
151
Returned value can be unicode or plain sring.
152
To convert plain string to unicode use
153
s.decode(bzrlib.user_encoding)
294
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
297
home = get_environ_unicode('HOME')
300
homepath = get_environ_unicode('HOMEPATH')
301
if homepath is not None:
302
return os.path.join(get_environ_unicode('HOMEDIR', ''), home)
157
SHGetSpecialFolderPath = \
158
ctypes.windll.shell32.SHGetSpecialFolderPathW
159
except AttributeError:
162
buf = ctypes.create_unicode_buffer(MAX_PATH)
163
if SHGetSpecialFolderPath(None,buf,CSIDL_PERSONAL,0):
165
# try for HOME env variable
166
home = os.path.expanduser('~')
303
169
# at least return windows root directory
304
windir = get_environ_unicode('WINDIR')
170
windir = os.environ.get('windir')
306
172
return os.path.splitdrive(windir)[0] + '/'
307
173
# otherwise C:\ is good enough for 98% users
308
return unicode('C:/')
311
177
def get_user_name():
312
178
"""Return user name as login name.
313
179
If name cannot be obtained return None.
181
Returned value can be unicode or plain sring.
182
To convert plain string to unicode use
183
s.decode(bzrlib.user_encoding)
322
192
buf = create_buffer(UNLEN+1)
323
193
n = ctypes.c_int(UNLEN+1)
324
194
if GetUserName(buf, ctypes.byref(n)):
325
return extract_buffer(buf)
326
196
# otherwise try env variables
327
return get_environ_unicode('USERNAME')
330
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
331
# computer or the cluster associated with the local computer."
332
_WIN32_ComputerNameDnsHostname = 1
197
return os.environ.get('USERNAME', None)
334
200
def get_host_name():
335
201
"""Return host machine name.
336
202
If name cannot be obtained return None.
338
:return: A unicode string representing the host name.
204
Returned value can be unicode or plain sring.
205
To convert plain string to unicode use
206
s.decode(bzrlib.user_encoding)
342
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
343
except (NotImplementedError, win32api.error):
344
# NotImplemented will happen on win9x...
348
210
kernel32 = ctypes.windll.kernel32
211
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix)
349
212
except AttributeError:
350
pass # Missing the module we need
352
215
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
353
216
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
355
# Try GetComputerNameEx which gives a proper Unicode hostname
356
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
358
if (GetComputerNameEx is not None
359
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
360
buf, ctypes.byref(n))):
361
return extract_buffer(buf)
363
# Try GetComputerName in case GetComputerNameEx wasn't found
364
# It returns the NETBIOS name, which isn't as good, but still ok.
365
# The first GetComputerNameEx might have changed 'n', so reset it
366
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
367
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
369
if (GetComputerName is not None
370
and GetComputerName(buf, ctypes.byref(n))):
371
return extract_buffer(buf)
372
return get_environ_unicode('COMPUTERNAME')
375
@symbol_versioning.deprecated_function(
376
symbol_versioning.deprecated_in((2, 5, 0)))
217
if GetComputerName(buf, ctypes.byref(n)):
219
# otherwise try env variables
220
return os.environ.get('COMPUTERNAME', None)
377
223
def _ensure_unicode(s):
378
224
if s and type(s) != unicode:
379
from bzrlib import osutils
380
s = s.decode(osutils.get_user_encoding())
226
s = s.decode(bzrlib.user_encoding)
384
get_appdata_location_unicode = symbol_versioning.deprecated_function(
385
symbol_versioning.deprecated_in((2, 5, 0)))(get_appdata_location)
387
get_home_location_unicode = symbol_versioning.deprecated_function(
388
symbol_versioning.deprecated_in((2, 5, 0)))(get_home_location)
390
get_user_name_unicode = symbol_versioning.deprecated_function(
391
symbol_versioning.deprecated_in((2, 5, 0)))(get_user_name)
393
get_host_name_unicode = symbol_versioning.deprecated_function(
394
symbol_versioning.deprecated_in((2, 5, 0)))(get_host_name)
230
def get_appdata_location_unicode():
231
return _ensure_unicode(get_appdata_location())
233
def get_home_location_unicode():
234
return _ensure_unicode(get_home_location())
236
def get_user_name_unicode():
237
return _ensure_unicode(get_user_name())
239
def get_host_name_unicode():
240
return _ensure_unicode(get_host_name())
397
243
def _ensure_with_dir(path):
398
if (not os.path.split(path)[0] or path.startswith(u'*')
399
or path.startswith(u'?')):
244
if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
400
245
return u'./' + path, True
402
247
return path, False
404
249
def _undo_ensure_with_dir(path, corrected):
442
268
if not file_list:
444
271
expanded_file_list = []
445
272
for possible_glob in file_list:
446
expanded_file_list.extend(glob_one(possible_glob))
447
return expanded_file_list
274
# work around bugs in glob.glob()
275
# - Python bug #1001604 ("glob doesn't return unicode with ...")
276
# - failing expansion for */* with non-iso-8859-* chars
277
possible_glob, corrected = _ensure_with_dir(possible_glob)
278
glob_files = glob.glob(possible_glob)
281
# special case to let the normal code path handle
282
# files that do not exists
283
expanded_file_list.append(
284
_undo_ensure_with_dir(possible_glob, corrected))
286
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
287
expanded_file_list += glob_files
289
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
450
292
def get_app_path(appname):
451
r"""Look up in Windows registry for full path to application executable.
452
Typically, applications create subkey with their basename
293
"""Look up in Windows registry for full path to application executable.
294
Typicaly, applications create subkey with their basename
453
295
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
455
297
:param appname: name of application (if no filename extension
458
300
or appname itself if nothing found.
304
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
305
r'SOFTWARE\Microsoft\Windows'
306
r'\CurrentVersion\App Paths')
307
except EnvironmentError:
462
310
basename = appname
463
311
if not os.path.splitext(basename)[1]:
464
312
basename = appname + '.exe'
467
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
468
'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
470
except EnvironmentError:
475
path, type_id = _winreg.QueryValueEx(hkey, '')
315
fullpath = _winreg.QueryValue(hkey, basename)
476
316
except WindowsError:
479
319
_winreg.CloseKey(hkey)
481
if type_id == REG_SZ:
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
491
def set_file_attr_hidden(path):
492
"""Set file attributes to hidden if possible"""
494
if winver != 'Windows 98':
495
SetFileAttributes = win32file.SetFileAttributesW
497
SetFileAttributes = win32file.SetFileAttributes
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)
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.
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.
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
516
:return: A list of unicode strings.
518
# First, split the command line
519
s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
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
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):]
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
538
for is_quoted, arg in arguments:
539
if is_quoted or not glob.has_magic(arg):
542
args.extend(glob_one(arg))
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:]
559
def get_environ_unicode(key, default=None):
560
"""Get `key` from environment as unicode or `default` if unset
562
The environment is natively unicode on modern windows versions but
563
Python 2 only accesses it through the legacy bytestring api.
565
Environmental variable names are case insenstive on Windows.
567
A large enough buffer will be allocated to retrieve the value, though
568
it may take two calls to the underlying library function.
570
This needs ctypes because pywin32 does not expose the wide version.
572
cfunc = getattr(get_environ_unicode, "_c_function", 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
580
buffer = ctypes.create_unicode_buffer(buffer_size)
581
length = cfunc(key, buffer, buffer_size)
583
code = ctypes.GetLastError()
584
if code == 203: # ERROR_ENVVAR_NOT_FOUND
586
raise ctypes.WinError(code)
587
if buffer_size > length:
588
return buffer[:length]
591
get_unicode_argv = None
592
def get_environ_unicode(key, default=None):
593
"""Get `key` from environment as unicode or `default` if unset
595
Fallback version that should basically never be needed.
597
from bzrlib import osutils
599
return os.environ[key].decode(osutils.get_user_encoding())
605
def _pywin32_is_local_pid_dead(pid):
606
"""True if pid doesn't correspond to live process on this machine"""
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
613
elif e[0] == 87: # ERROR_INVALID_PARAMETER
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
630
errorcode = ctypes.GetLastError()
631
if errorcode == 5: # ERROR_ACCESS_DENIED
632
# Probably something alive we're not allowed to kill
634
elif errorcode == 87: # ERROR_INVALID_PARAMETER
636
raise ctypes.WinError(errorcode)
639
is_local_pid_dead = _ctypes_is_local_pid_dead
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):
added
removed
bzrlib/win32utils.py
