19
19
Only one dependency: ctypes should be installed.
22
from __future__ import absolute_import
32
from breezy.i18n import gettext
28
from bzrlib import cmdline
34
has_ctypes_win32 = False
35
31
if sys.platform == 'win32':
39
has_ctypes_win32 = False
32
_major,_minor,_build,_platform,_text = sys.getwindowsversion()
35
# The operating system platform.
36
# This member can be one of the following values.
37
# ========================== ======================================
39
# -------------------------- --------------------------------------
40
# VER_PLATFORM_WIN32_NT The operating system is Windows Vista,
41
# 2 Windows Server "Longhorn",
42
# Windows Server 2003, Windows XP,
43
# Windows 2000, or Windows NT.
45
# VER_PLATFORM_WIN32_WINDOWS The operating system is Windows Me,
46
# 1 Windows 98, or Windows 95.
47
# ========================== ======================================
51
# don't care about real Windows name, just to force safe operations
57
# We can cope without it; use a separate variable to help pyflakes
64
if winver == 'Windows 98':
65
create_buffer = ctypes.create_string_buffer
68
create_buffer = ctypes.create_unicode_buffer
82
# pulling in win32com.shell is a bit of overhead, and normally we don't need
83
# it as ctypes is preferred and common. lazy_imports and "optional"
84
# modules don't work well, so we do our own lazy thing...
85
has_win32com_shell = None # Set to True or False once we know for sure...
42
87
# Special Win32 API constants
43
88
# Handles of std streams
78
122
('PagefileUsage', ctypes.c_size_t),
79
123
('PeakPagefileUsage', ctypes.c_size_t),
80
124
('PrivateUsage', ctypes.c_size_t),
82
126
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
83
127
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
84
ret = ctypes.windll.psapi.GetProcessMemoryInfo(
85
cur_process, ctypes.byref(mem_struct), ctypes.sizeof(mem_struct))
128
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
129
ctypes.byref(mem_struct),
130
ctypes.sizeof(mem_struct))
87
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
132
trace.note('Failed to GetProcessMemoryInfo()')
89
134
info = {'PageFaultCount': mem_struct.PageFaultCount,
90
135
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
97
142
'PagefileUsage': mem_struct.PagefileUsage,
98
143
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
99
144
'PrivateUsage': mem_struct.PrivateUsage,
148
# win32process does not return PrivateUsage, because it doesn't use
149
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
150
proc = win32process.GetCurrentProcess()
151
info = win32process.GetProcessMemoryInfo(proc)
102
trace.note(gettext('Cannot debug memory on win32 without ctypes'
153
trace.note('Cannot debug memory on win32 without ctypes'
106
157
# using base-2 units (see HACKING.txt).
107
trace.note(gettext('WorkingSize {0:>7}KiB'
108
'\tPeakWorking {1:>7}KiB\t{2}').format(
158
trace.note('WorkingSize %7dKiB'
159
'\tPeakWorking %7dKiB\t%s',
109
160
info['WorkingSetSize'] / 1024,
110
161
info['PeakWorkingSetSize'] / 1024,
114
165
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'),
166
trace.note('WorkingSize %8d KiB', info['WorkingSetSize'] / 1024)
167
trace.note('PeakWorking %8d KiB', info['PeakWorkingSetSize'] / 1024)
168
trace.note('PagefileUsage %8d KiB', info.get('PagefileUsage', 0) / 1024)
169
trace.note('PeakPagefileUsage %8d KiB',
122
170
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))
171
trace.note('PrivateUsage %8d KiB', info.get('PrivateUsage', 0) / 1024)
172
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
128
175
def get_console_size(defaultx=80, defaulty=25):
168
215
buf = ctypes.create_unicode_buffer(MAX_PATH)
169
if SHGetSpecialFolderPath(None, buf, csidl, 0):
216
if SHGetSpecialFolderPath(None,buf,csidl,0):
219
global has_win32com_shell
220
if has_win32com_shell is None:
222
from win32com.shell import shell
223
has_win32com_shell = True
225
has_win32com_shell = False
226
if has_win32com_shell:
227
# still need to bind the name locally, but this is fast.
228
from win32com.shell import shell
230
return shell.SHGetSpecialFolderPath(0, csidl, 0)
232
# possibly E_NOTIMPL meaning we can't load the function pointer,
233
# or E_FAIL meaning the function failed - regardless, just ignore it
179
243
one that moves with the user as they logon to different machines, and
180
244
a 'local' one that stays local to the machine. This returns the 'roaming'
181
245
directory, and thus is suitable for storing user-preferences, etc.
247
Returned value can be unicode or plain string.
248
To convert plain string to unicode use
249
s.decode(osutils.get_user_encoding())
250
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
183
252
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
186
# Use APPDATA if defined, will return None if not
187
return get_environ_unicode('APPDATA')
256
appdata = os.environ.get('APPDATA')
259
# if we fall to this point we on win98
260
# at least try C:/WINDOWS/Application Data
261
windir = os.environ.get('windir')
263
appdata = os.path.join(windir, 'Application Data')
264
if os.path.isdir(appdata):
266
# did not find anything
190
270
def get_local_appdata_location():
212
297
Assume on win32 it's the <My Documents> folder.
213
298
If location cannot be obtained return system drive root,
301
Returned value can be unicode or plain string.
302
To convert plain string to unicode use
303
s.decode(osutils.get_user_encoding())
216
305
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
219
home = get_environ_unicode('HOME')
308
# try for HOME env variable
309
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
312
# at least return windows root directory
226
windir = get_environ_unicode('WINDIR')
313
windir = os.environ.get('windir')
228
315
return os.path.splitdrive(windir)[0] + '/'
229
316
# otherwise C:\ is good enough for 98% users
233
320
def get_user_name():
234
321
"""Return user name as login name.
235
322
If name cannot be obtained return None.
324
Returned value can be unicode or plain string.
325
To convert plain string to unicode use
326
s.decode(osutils.get_user_encoding())
239
330
advapi32 = ctypes.windll.advapi32
240
GetUserName = getattr(advapi32, 'GetUserNameW')
331
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
241
332
except AttributeError:
244
buf = ctypes.create_unicode_buffer(UNLEN + 1)
245
n = ctypes.c_int(UNLEN + 1)
335
buf = create_buffer(UNLEN+1)
336
n = ctypes.c_int(UNLEN+1)
246
337
if GetUserName(buf, ctypes.byref(n)):
248
339
# otherwise try env variables
249
return get_environ_unicode('USERNAME')
340
return os.environ.get('USERNAME', None)
252
343
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
253
344
# computer or the cluster associated with the local computer."
254
345
_WIN32_ComputerNameDnsHostname = 1
257
347
def get_host_name():
258
348
"""Return host machine name.
259
349
If name cannot be obtained return None.
261
:return: A unicode string representing the host name.
351
:return: A unicode string representing the host name. On win98, this may be
352
a plain string as win32 api doesn't support unicode.
356
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
357
except (NotImplementedError, win32api.error):
358
# NotImplemented will happen on win9x...
265
362
kernel32 = ctypes.windll.kernel32
266
363
except AttributeError:
267
pass # Missing the module we need
364
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)
366
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
367
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
272
369
# Try GetComputerNameEx which gives a proper Unicode hostname
273
GetComputerNameEx = getattr(kernel32, 'GetComputerNameExW', None)
370
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
274
372
if (GetComputerNameEx is not None
275
373
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
276
374
buf, ctypes.byref(n))):
278
return get_environ_unicode('COMPUTERNAME')
377
# Try GetComputerName in case GetComputerNameEx wasn't found
378
# It returns the NETBIOS name, which isn't as good, but still ok.
379
# The first GetComputerNameEx might have changed 'n', so reset it
380
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
381
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
383
if (GetComputerName is not None
384
and GetComputerName(buf, ctypes.byref(n))):
386
# otherwise try env variables, which will be 'mbcs' encoded
387
# on Windows (Python doesn't expose the native win32 unicode environment)
389
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
390
# environment variables should always be encoded in 'mbcs'.
392
return os.environ['COMPUTERNAME'].decode("mbcs")
397
def _ensure_unicode(s):
398
if s and type(s) != unicode:
399
from bzrlib import osutils
400
s = s.decode(osutils.get_user_encoding())
404
def get_appdata_location_unicode():
405
return _ensure_unicode(get_appdata_location())
407
def get_home_location_unicode():
408
return _ensure_unicode(get_home_location())
410
def get_user_name_unicode():
411
return _ensure_unicode(get_user_name())
413
def get_host_name_unicode():
414
return _ensure_unicode(get_host_name())
281
417
def _ensure_with_dir(path):
282
418
if (not os.path.split(path)[0] or path.startswith(u'*')
283
or path.startswith(u'?')):
419
or path.startswith(u'?')):
284
420
return u'./' + path, True
286
422
return path, False
289
424
def _undo_ensure_with_dir(path, corrected):
376
512
def set_file_attr_hidden(path):
377
513
"""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)
392
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
515
if winver != 'Windows 98':
516
SetFileAttributes = win32file.SetFileAttributesW
518
SetFileAttributes = win32file.SetFileAttributes
520
SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
521
except pywintypes.error, e:
522
from bzrlib import trace
523
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
526
def _command_line_to_argv(command_line, single_quotes_allowed=False):
393
527
"""Convert a Unicode command line into a list of argv arguments.
395
529
It performs wildcard expansion to make wildcards act closer to how they
403
537
: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
413
# args from the very same PEB as does GetCommandLineW
416
# Now shorten the command line we get from GetCommandLineW to match sys.argv
417
if len(arguments) < len(argv):
418
raise AssertionError("Split command line can't be shorter than argv")
419
arguments = arguments[len(arguments) - len(argv):]
421
# Carry on to process globs (metachars) in the command line
422
# expand globs if necessary
539
s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
540
# Now that we've split the content, expand globs if necessary
423
541
# TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
424
542
# '**/' style globs
426
for is_quoted, arg in arguments:
544
for is_quoted, arg in s:
427
545
if is_quoted or not glob.has_magic(arg):
440
558
if command_line is None:
441
559
raise ctypes.WinError()
442
560
# Skip the first argument, since we only care about parameters
443
argv = _command_line_to_argv(command_line, sys.argv)[1:]
561
argv = _command_line_to_argv(command_line)[1:]
562
if getattr(sys, 'frozen', None) is None:
563
# Invoked via 'python.exe' which takes the form:
564
# python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
565
# we need to get only BZR_OPTIONS part,
566
# We already removed 'python.exe' so we remove everything up to and
567
# including the first non-option ('-') argument.
568
for idx in xrange(len(argv)):
569
if argv[idx][: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
574
get_unicode_argv = None