19
19
Only one dependency: ctypes should be installed.
22
from __future__ import absolute_import
27
from bzrlib import cmdline
34
from bzrlib.i18n import gettext
30
37
if sys.platform == 'win32':
63
70
if winver == 'Windows 98':
64
71
create_buffer = ctypes.create_string_buffer
72
def extract_buffer(buf):
73
return buf.value.decode("mbcs")
67
76
create_buffer = ctypes.create_unicode_buffer
77
extract_buffer = operator.attrgetter("value")
83
has_pywintypes = has_win32file = has_win32api = False
81
96
# pulling in win32com.shell is a bit of overhead, and normally we don't need
82
97
# it as ctypes is preferred and common. lazy_imports and "optional"
128
143
ctypes.byref(mem_struct),
129
144
ctypes.sizeof(mem_struct))
131
trace.note('Failed to GetProcessMemoryInfo()')
146
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
133
148
info = {'PageFaultCount': mem_struct.PageFaultCount,
134
149
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
149
164
proc = win32process.GetCurrentProcess()
150
165
info = win32process.GetProcessMemoryInfo(proc)
152
trace.note('Cannot debug memory on win32 without ctypes'
167
trace.note(gettext('Cannot debug memory on win32 without ctypes'
156
171
# using base-2 units (see HACKING.txt).
157
trace.note('WorkingSize %7dKiB'
158
'\tPeakWorking %7dKiB\t%s',
172
trace.note(gettext('WorkingSize {0:>7}KiB'
173
'\tPeakWorking {1:>7}KiB\t{2}').format(
159
174
info['WorkingSetSize'] / 1024,
160
175
info['PeakWorkingSetSize'] / 1024,
164
179
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',
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'),
169
184
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))
185
trace.note(gettext('PrivateUsage %8d KiB'), info.get('PrivateUsage', 0) / 1024)
186
trace.note(gettext('PageFaultCount %8d'), info.get('PageFaultCount', 0))
174
189
def get_console_size(defaultx=80, defaulty=25):
242
257
one that moves with the user as they logon to different machines, and
243
258
a 'local' one that stays local to the machine. This returns the 'roaming'
244
259
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')
251
261
appdata = _get_sh_special_folder_path(CSIDL_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
264
# Use APPDATA if defined, will return None if not
265
return get_environ_unicode('APPDATA')
269
268
def get_local_appdata_location():
275
274
a 'local' one that stays local to the machine. This returns the 'local'
276
275
directory, and thus is suitable for caches, temp files and other things
277
276
which don't need to move with the user.
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')
284
278
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
287
281
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
288
local = os.environ.get('LOCALAPPDATA')
282
local = get_environ_unicode('LOCALAPPDATA')
291
285
return get_appdata_location()
296
290
Assume on win32 it's the <My Documents> folder.
297
291
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())
304
294
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
307
# try for HOME env variable
308
home = os.path.expanduser('~')
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)
311
303
# at least return windows root directory
312
windir = os.environ.get('windir')
304
windir = get_environ_unicode('WINDIR')
314
306
return os.path.splitdrive(windir)[0] + '/'
315
307
# otherwise C:\ is good enough for 98% users
308
return unicode('C:/')
319
311
def get_user_name():
320
312
"""Return user name as login name.
321
313
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())
334
322
buf = create_buffer(UNLEN+1)
335
323
n = ctypes.c_int(UNLEN+1)
336
324
if GetUserName(buf, ctypes.byref(n)):
325
return extract_buffer(buf)
338
326
# otherwise try env variables
339
return os.environ.get('USERNAME', None)
327
return get_environ_unicode('USERNAME')
342
330
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
347
335
"""Return host machine name.
348
336
If name cannot be obtained return None.
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.
338
:return: A unicode string representing the host name.
371
358
if (GetComputerNameEx is not None
372
359
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
373
360
buf, ctypes.byref(n))):
361
return extract_buffer(buf)
376
363
# Try GetComputerName in case GetComputerNameEx wasn't found
377
364
# It returns the NETBIOS name, which isn't as good, but still ok.
382
369
if (GetComputerName is not None
383
370
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")
371
return extract_buffer(buf)
372
return get_environ_unicode('COMPUTERNAME')
375
@symbol_versioning.deprecated_function(
376
symbol_versioning.deprecated_in((2, 5, 0)))
396
377
def _ensure_unicode(s):
397
378
if s and type(s) != unicode:
398
379
from bzrlib import osutils
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())
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)
416
397
def _ensure_with_dir(path):
566
if has_ctypes and winver != 'Windows 98':
546
if has_ctypes and winver == 'Windows NT':
567
547
def get_unicode_argv():
568
548
prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
569
549
GetCommandLineW = prototype(("GetCommandLineW",
574
554
# Skip the first argument, since we only care about parameters
575
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]
578
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())
614
637
_CloseHandle(handle)
616
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
