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