19
19
Only one dependency: ctypes should be installed.
22
from __future__ import absolute_import
32
from breezy.i18n import gettext
27
from bzrlib import cmdline
34
has_ctypes_win32 = False
35
30
if sys.platform == 'win32':
39
has_ctypes_win32 = False
31
_major,_minor,_build,_platform,_text = sys.getwindowsversion()
34
# The operating system platform.
35
# This member can be one of the following values.
36
# ========================== ======================================
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.
44
# VER_PLATFORM_WIN32_WINDOWS The operating system is Windows Me,
45
# 1 Windows 98, or Windows 95.
46
# ========================== ======================================
50
# don't care about real Windows name, just to force safe operations
56
# We can cope without it; use a separate variable to help pyflakes
63
if winver == 'Windows 98':
64
create_buffer = ctypes.create_string_buffer
67
create_buffer = ctypes.create_unicode_buffer
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...
42
86
# Special Win32 API constants
43
87
# Handles of std streams
78
121
('PagefileUsage', ctypes.c_size_t),
79
122
('PeakPagefileUsage', ctypes.c_size_t),
80
123
('PrivateUsage', ctypes.c_size_t),
82
125
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
83
126
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
84
ret = ctypes.windll.psapi.GetProcessMemoryInfo(
85
cur_process, ctypes.byref(mem_struct), ctypes.sizeof(mem_struct))
127
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
128
ctypes.byref(mem_struct),
129
ctypes.sizeof(mem_struct))
87
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
131
trace.note('Failed to GetProcessMemoryInfo()')
89
133
info = {'PageFaultCount': mem_struct.PageFaultCount,
90
134
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
97
141
'PagefileUsage': mem_struct.PagefileUsage,
98
142
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
99
143
'PrivateUsage': mem_struct.PrivateUsage,
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)
102
trace.note(gettext('Cannot debug memory on win32 without ctypes'
152
trace.note('Cannot debug memory on win32 without ctypes'
106
156
# using base-2 units (see HACKING.txt).
107
trace.note(gettext('WorkingSize {0:>7}KiB'
108
'\tPeakWorking {1:>7}KiB\t{2}').format(
157
trace.note('WorkingSize %7dKiB'
158
'\tPeakWorking %7dKiB\t%s',
109
159
info['WorkingSetSize'] / 1024,
110
160
info['PeakWorkingSetSize'] / 1024,
114
164
trace.note('%s', message)
115
trace.note(gettext('WorkingSize %8d KiB'),
116
info['WorkingSetSize'] / 1024)
117
trace.note(gettext('PeakWorking %8d KiB'),
118
info['PeakWorkingSetSize'] / 1024)
119
trace.note(gettext('PagefileUsage %8d KiB'),
120
info.get('PagefileUsage', 0) / 1024)
121
trace.note(gettext('PeakPagefileUsage %8d KiB'),
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',
122
169
info.get('PeakPagefileUsage', 0) / 1024)
123
trace.note(gettext('PrivateUsage %8d KiB'),
124
info.get('PrivateUsage', 0) / 1024)
125
trace.note(gettext('PageFaultCount %8d'), info.get('PageFaultCount', 0))
170
trace.note('PrivateUsage %8d KiB', info.get('PrivateUsage', 0) / 1024)
171
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
128
174
def get_console_size(defaultx=80, defaulty=25):
168
214
buf = ctypes.create_unicode_buffer(MAX_PATH)
169
if SHGetSpecialFolderPath(None, buf, csidl, 0):
215
if SHGetSpecialFolderPath(None,buf,csidl,0):
218
global has_win32com_shell
219
if has_win32com_shell is None:
221
from win32com.shell import shell
222
has_win32com_shell = True
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
229
return shell.SHGetSpecialFolderPath(0, csidl, 0)
231
# possibly E_NOTIMPL meaning we can't load the function pointer,
232
# or E_FAIL meaning the function failed - regardless, just ignore it
179
242
one that moves with the user as they logon to different machines, and
180
243
a 'local' one that stays local to the machine. This returns the 'roaming'
181
244
directory, and thus is suitable for storing user-preferences, etc.
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')
183
251
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
186
# Use APPDATA if defined, will return None if not
187
return get_environ_unicode('APPDATA')
255
appdata = os.environ.get('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')
262
appdata = os.path.join(windir, 'Application Data')
263
if os.path.isdir(appdata):
265
# did not find anything
190
269
def get_local_appdata_location():
212
296
Assume on win32 it's the <My Documents> folder.
213
297
If location cannot be obtained return system drive root,
300
Returned value can be unicode or plain string.
301
To convert plain string to unicode use
302
s.decode(osutils.get_user_encoding())
216
304
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
219
home = get_environ_unicode('HOME')
307
# try for HOME env variable
308
home = os.path.expanduser('~')
222
homepath = get_environ_unicode('HOMEPATH')
223
if homepath is not None:
224
return os.path.join(get_environ_unicode('HOMEDIR', ''), home)
225
311
# at least return windows root directory
226
windir = get_environ_unicode('WINDIR')
312
windir = os.environ.get('windir')
228
314
return os.path.splitdrive(windir)[0] + '/'
229
315
# otherwise C:\ is good enough for 98% users
233
319
def get_user_name():
234
320
"""Return user name as login name.
235
321
If name cannot be obtained return None.
323
Returned value can be unicode or plain string.
324
To convert plain string to unicode use
325
s.decode(osutils.get_user_encoding())
239
329
advapi32 = ctypes.windll.advapi32
240
GetUserName = getattr(advapi32, 'GetUserNameW')
330
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
241
331
except AttributeError:
244
buf = ctypes.create_unicode_buffer(UNLEN + 1)
245
n = ctypes.c_int(UNLEN + 1)
334
buf = create_buffer(UNLEN+1)
335
n = ctypes.c_int(UNLEN+1)
246
336
if GetUserName(buf, ctypes.byref(n)):
248
338
# otherwise try env variables
249
return get_environ_unicode('USERNAME')
339
return os.environ.get('USERNAME', None)
252
342
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
253
343
# computer or the cluster associated with the local computer."
254
344
_WIN32_ComputerNameDnsHostname = 1
257
346
def get_host_name():
258
347
"""Return host machine name.
259
348
If name cannot be obtained return None.
261
:return: A unicode string representing the host name.
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.
355
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
356
except (NotImplementedError, win32api.error):
357
# NotImplemented will happen on win9x...
265
361
kernel32 = ctypes.windll.kernel32
266
362
except AttributeError:
267
pass # Missing the module we need
363
pass # Missing the module we need
269
buf = ctypes.create_unicode_buffer(MAX_COMPUTERNAME_LENGTH + 1)
270
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH + 1)
365
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
366
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
272
368
# Try GetComputerNameEx which gives a proper Unicode hostname
273
GetComputerNameEx = getattr(kernel32, 'GetComputerNameExW', None)
369
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
274
371
if (GetComputerNameEx is not None
275
372
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
276
373
buf, ctypes.byref(n))):
278
return get_environ_unicode('COMPUTERNAME')
376
# Try GetComputerName in case GetComputerNameEx wasn't found
377
# It returns the NETBIOS name, which isn't as good, but still ok.
378
# The first GetComputerNameEx might have changed 'n', so reset it
379
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
380
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
382
if (GetComputerName is not None
383
and GetComputerName(buf, ctypes.byref(n))):
385
# otherwise try env variables, which will be 'mbcs' encoded
386
# on Windows (Python doesn't expose the native win32 unicode environment)
388
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
389
# environment variables should always be encoded in 'mbcs'.
391
return os.environ['COMPUTERNAME'].decode("mbcs")
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())
403
def get_appdata_location_unicode():
404
return _ensure_unicode(get_appdata_location())
406
def get_home_location_unicode():
407
return _ensure_unicode(get_home_location())
409
def get_user_name_unicode():
410
return _ensure_unicode(get_user_name())
412
def get_host_name_unicode():
413
return _ensure_unicode(get_host_name())
281
416
def _ensure_with_dir(path):
282
417
if (not os.path.split(path)[0] or path.startswith(u'*')
283
or path.startswith(u'?')):
418
or path.startswith(u'?')):
284
419
return u'./' + path, True
286
421
return path, False
289
423
def _undo_ensure_with_dir(path, corrected):
376
511
def set_file_attr_hidden(path):
377
512
"""Set file attributes to hidden if possible"""
378
if not has_ctypes_win32:
380
from ctypes.wintypes import BOOL, DWORD, LPCWSTR
381
_kernel32 = ctypes.windll.kernel32
382
# <https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-setfileattributesw>
383
_SetFileAttributesW = ctypes.WINFUNCTYPE(BOOL, LPCWSTR, DWORD)(
384
("SetFileAttributesW", _kernel32))
385
FILE_ATTRIBUTE_HIDDEN = 2
386
if not SetFileAttributes(path, FILE_ATTRIBUTE_HIDDEN):
387
e = ctypes.WinError()
389
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
514
if winver != 'Windows 98':
515
SetFileAttributes = win32file.SetFileAttributesW
517
SetFileAttributes = win32file.SetFileAttributes
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)
392
525
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
403
536
:return: A list of unicode strings.
405
# First, split the command line
406
s = cmdline.Splitter(
407
command_line, single_quotes_allowed=single_quotes_allowed)
409
# Bug #587868 Now make sure that the length of s agrees with sys.argv
410
# we do this by simply counting the number of arguments in each. The counts should
411
# agree no matter what encoding sys.argv is in (AFAIK)
412
# len(arguments) < len(sys.argv) should be an impossibility since python gets
538
# First, spit the command line
539
s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
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
413
545
# args from the very same PEB as does GetCommandLineW
414
546
arguments = list(s)
416
548
# Now shorten the command line we get from GetCommandLineW to match sys.argv
417
549
if len(arguments) < len(argv):
418
550
raise AssertionError("Split command line can't be shorter than argv")
419
551
arguments = arguments[len(arguments) - len(argv):]
421
553
# Carry on to process globs (metachars) in the command line
422
554
# expand globs if necessary
423
555
# TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
442
574
# Skip the first argument, since we only care about parameters
443
575
argv = _command_line_to_argv(command_line, sys.argv)[1:]
446
def get_environ_unicode(key, default=None):
447
"""Get `key` from environment as unicode or `default` if unset
449
The environment is natively unicode on modern windows versions but
450
Python 2 only accesses it through the legacy bytestring api.
452
Environmental variable names are case insenstive on Windows.
454
A large enough buffer will be allocated to retrieve the value, though
455
it may take two calls to the underlying library function.
457
cfunc = getattr(get_environ_unicode, "_c_function", None)
459
from ctypes.wintypes import DWORD, LPCWSTR, LPWSTR
460
cfunc = ctypes.WINFUNCTYPE(DWORD, LPCWSTR, LPWSTR, DWORD)(
461
("GetEnvironmentVariableW", ctypes.windll.kernel32))
462
get_environ_unicode._c_function = cfunc
463
buffer_size = 256 # heuristic, 256 characters often enough
465
buf = ctypes.create_unicode_buffer(buffer_size)
466
length = cfunc(key, buf, buffer_size)
468
code = ctypes.GetLastError()
469
if code == 203: # ERROR_ENVVAR_NOT_FOUND
471
raise ctypes.WinError(code)
472
if buffer_size > length:
478
from ctypes.wintypes import BOOL, DWORD, HANDLE
479
_kernel32 = ctypes.windll.kernel32
480
_CloseHandle = ctypes.WINFUNCTYPE(BOOL, HANDLE)(
481
("CloseHandle", _kernel32))
482
_OpenProcess = ctypes.WINFUNCTYPE(HANDLE, DWORD, BOOL, DWORD)(
483
("OpenProcess", _kernel32))
485
def _ctypes_is_local_pid_dead(pid):
486
"""True if pid doesn't correspond to live process on this machine"""
487
handle = _OpenProcess(1, False, pid) # PROCESS_TERMINATE
489
errorcode = ctypes.GetLastError()
490
if errorcode == 5: # ERROR_ACCESS_DENIED
491
# Probably something alive we're not allowed to kill
493
elif errorcode == 87: # ERROR_INVALID_PARAMETER
495
raise ctypes.WinError(errorcode)
499
is_local_pid_dead = _ctypes_is_local_pid_dead
578
get_unicode_argv = None