3
Set of functions to work with console on Windows.
4
Author: Alexander Belchenko (e-mail: bialix AT ukr.net)
1
# Copyright (C) 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Win32-specific helper functions
19
Only one dependency: ctypes should be installed.
28
if sys.platform == 'win32':
29
_major,_minor,_build,_platform,_text = sys.getwindowsversion()
32
# The operating system platform.
33
# This member can be one of the following values.
34
# ========================== ======================================
36
# -------------------------- --------------------------------------
37
# VER_PLATFORM_WIN32_NT The operating system is Windows Vista,
38
# 2 Windows Server "Longhorn",
39
# Windows Server 2003, Windows XP,
40
# Windows 2000, or Windows NT.
42
# VER_PLATFORM_WIN32_WINDOWS The operating system is Windows Me,
43
# 1 Windows 98, or Windows 95.
44
# ========================== ======================================
48
# don't care about real Windows name, just to force safe operations
54
# We can cope without it; use a separate variable to help pyflakes
61
if winver == 'Windows 98':
62
create_buffer = ctypes.create_string_buffer
65
create_buffer = ctypes.create_unicode_buffer
78
# pulling in win32com.shell is a bit of overhead, and normally we don't need
79
# it as ctypes is preferred and common. lazy_imports and "optional"
80
# modules don't work well, so we do our own lazy thing...
81
has_win32com_shell = None # Set to True or False once we know for sure...
83
# Special Win32 API constants
84
# Handles of std streams
16
85
WIN32_STDIN_HANDLE = -10
17
86
WIN32_STDOUT_HANDLE = -11
18
87
WIN32_STDERR_HANDLE = -12
89
# CSIDL constants (from MSDN 2003)
90
CSIDL_APPDATA = 0x001A # Application Data folder
91
CSIDL_LOCAL_APPDATA = 0x001c# <user name>\Local Settings\Application Data (non roaming)
92
CSIDL_PERSONAL = 0x0005 # My Documents folder
94
# from winapi C headers
97
MAX_COMPUTERNAME_LENGTH = 31
100
def debug_memory_win32api(message='', short=True):
101
"""Use trace.note() to dump the running memory info."""
102
from bzrlib import trace
104
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
105
"""Used by GetProcessMemoryInfo"""
106
_fields_ = [('cb', ctypes.c_ulong),
107
('PageFaultCount', ctypes.c_ulong),
108
('PeakWorkingSetSize', ctypes.c_size_t),
109
('WorkingSetSize', ctypes.c_size_t),
110
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
111
('QuotaPagedPoolUsage', ctypes.c_size_t),
112
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
113
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
114
('PagefileUsage', ctypes.c_size_t),
115
('PeakPagefileUsage', ctypes.c_size_t),
116
('PrivateUsage', ctypes.c_size_t),
118
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
119
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
120
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
121
ctypes.byref(mem_struct),
122
ctypes.sizeof(mem_struct))
124
trace.note('Failed to GetProcessMemoryInfo()')
126
info = {'PageFaultCount': mem_struct.PageFaultCount,
127
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
128
'WorkingSetSize': mem_struct.WorkingSetSize,
129
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
130
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
131
'QuotaPeakNonPagedPoolUsage': mem_struct.QuotaPeakNonPagedPoolUsage,
132
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
133
'PagefileUsage': mem_struct.PagefileUsage,
134
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
135
'PrivateUsage': mem_struct.PrivateUsage,
139
# win32process does not return PrivateUsage, because it doesn't use
140
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
141
proc = win32process.GetCurrentProcess()
142
info = win32process.GetProcessMemoryInfo(proc)
144
trace.note('Cannot debug memory on win32 without ctypes'
148
trace.note('WorkingSize %7dKB'
149
'\tPeakWorking %7dKB\t%s',
150
info['WorkingSetSize'] / 1024,
151
info['PeakWorkingSetSize'] / 1024,
155
trace.note('%s', message)
156
trace.note('WorkingSize %8d KB', info['WorkingSetSize'] / 1024)
157
trace.note('PeakWorking %8d KB', info['PeakWorkingSetSize'] / 1024)
158
trace.note('PagefileUsage %8d KB', info.get('PagefileUsage', 0) / 1024)
159
trace.note('PeakPagefileUsage %8d KB', info.get('PeakPagefileUsage', 0) / 1024)
160
trace.note('PrivateUsage %8d KB', info.get('PrivateUsage', 0) / 1024)
161
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
21
164
def get_console_size(defaultx=80, defaulty=25):
22
""" Return size of current console.
24
This function try to determine actual size of current working
25
console window and return tuple (sizex, sizey) if success,
26
or default size (defaultx, defaulty) otherwise.
28
Dependencies: ctypes should be installed.
32
return (defaultx, defaulty)
34
# To avoid problem with redirecting output via pipe
35
# need to use stderr instead of stdout
36
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
37
csbi = ctypes.create_string_buffer(22)
38
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
41
(bufx, bufy, curx, cury, wattr,
165
"""Return size of current console.
167
This function try to determine actual size of current working
168
console window and return tuple (sizex, sizey) if success,
169
or default size (defaultx, defaulty) otherwise.
173
return (defaultx, defaulty)
175
# To avoid problem with redirecting output via pipe
176
# need to use stderr instead of stdout
177
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
178
csbi = ctypes.create_string_buffer(22)
179
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
182
(bufx, bufy, curx, cury, wattr,
42
183
left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
43
sizex = right - left + 1
44
sizey = bottom - top + 1
47
return (defaultx, defaulty)
184
sizex = right - left + 1
185
sizey = bottom - top + 1
186
return (sizex, sizey)
188
return (defaultx, defaulty)
191
def _get_sh_special_folder_path(csidl):
192
"""Call SHGetSpecialFolderPathW if available, or return None.
194
Result is always unicode (or None).
198
SHGetSpecialFolderPath = \
199
ctypes.windll.shell32.SHGetSpecialFolderPathW
200
except AttributeError:
203
buf = ctypes.create_unicode_buffer(MAX_PATH)
204
if SHGetSpecialFolderPath(None,buf,csidl,0):
207
global has_win32com_shell
208
if has_win32com_shell is None:
210
from win32com.shell import shell
211
has_win32com_shell = True
213
has_win32com_shell = False
214
if has_win32com_shell:
215
# still need to bind the name locally, but this is fast.
216
from win32com.shell import shell
218
return shell.SHGetSpecialFolderPath(0, csidl, 0)
220
# possibly E_NOTIMPL meaning we can't load the function pointer,
221
# or E_FAIL meaning the function failed - regardless, just ignore it
226
def get_appdata_location():
227
"""Return Application Data location.
228
Return None if we cannot obtain location.
230
Windows defines two 'Application Data' folders per user - a 'roaming'
231
one that moves with the user as they logon to different machines, and
232
a 'local' one that stays local to the machine. This returns the 'roaming'
233
directory, and thus is suitable for storing user-preferences, etc.
235
Returned value can be unicode or plain string.
236
To convert plain string to unicode use
237
s.decode(osutils.get_user_encoding())
238
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
240
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
244
appdata = os.environ.get('APPDATA')
247
# if we fall to this point we on win98
248
# at least try C:/WINDOWS/Application Data
249
windir = os.environ.get('windir')
251
appdata = os.path.join(windir, 'Application Data')
252
if os.path.isdir(appdata):
254
# did not find anything
258
def get_local_appdata_location():
259
"""Return Local Application Data location.
260
Return the same as get_appdata_location() if we cannot obtain location.
262
Windows defines two 'Application Data' folders per user - a 'roaming'
263
one that moves with the user as they logon to different machines, and
264
a 'local' one that stays local to the machine. This returns the 'local'
265
directory, and thus is suitable for caches, temp files and other things
266
which don't need to move with the user.
268
Returned value can be unicode or plain string.
269
To convert plain string to unicode use
270
s.decode(bzrlib.user_encoding)
271
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
273
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
276
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
277
local = os.environ.get('LOCALAPPDATA')
280
return get_appdata_location()
283
def get_home_location():
284
"""Return user's home location.
285
Assume on win32 it's the <My Documents> folder.
286
If location cannot be obtained return system drive root,
289
Returned value can be unicode or plain sring.
290
To convert plain string to unicode use
291
s.decode(osutils.get_user_encoding())
293
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
296
# try for HOME env variable
297
home = os.path.expanduser('~')
300
# at least return windows root directory
301
windir = os.environ.get('windir')
303
return os.path.splitdrive(windir)[0] + '/'
304
# otherwise C:\ is good enough for 98% users
309
"""Return user name as login name.
310
If name cannot be obtained return None.
312
Returned value can be unicode or plain sring.
313
To convert plain string to unicode use
314
s.decode(osutils.get_user_encoding())
318
advapi32 = ctypes.windll.advapi32
319
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
320
except AttributeError:
323
buf = create_buffer(UNLEN+1)
324
n = ctypes.c_int(UNLEN+1)
325
if GetUserName(buf, ctypes.byref(n)):
327
# otherwise try env variables
328
return os.environ.get('USERNAME', None)
331
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
332
# computer or the cluster associated with the local computer."
333
_WIN32_ComputerNameDnsHostname = 1
336
"""Return host machine name.
337
If name cannot be obtained return None.
339
:return: A unicode string representing the host name. On win98, this may be
340
a plain string as win32 api doesn't support unicode.
344
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
345
except (NotImplementedError, win32api.error):
346
# NotImplemented will happen on win9x...
350
kernel32 = ctypes.windll.kernel32
351
except AttributeError:
352
pass # Missing the module we need
354
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
355
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
357
# Try GetComputerNameEx which gives a proper Unicode hostname
358
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
360
if (GetComputerNameEx is not None
361
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
362
buf, ctypes.byref(n))):
365
# Try GetComputerName in case GetComputerNameEx wasn't found
366
# It returns the NETBIOS name, which isn't as good, but still ok.
367
# The first GetComputerNameEx might have changed 'n', so reset it
368
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
369
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
371
if (GetComputerName is not None
372
and GetComputerName(buf, ctypes.byref(n))):
374
# otherwise try env variables, which will be 'mbcs' encoded
375
# on Windows (Python doesn't expose the native win32 unicode environment)
377
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
378
# environment variables should always be encoded in 'mbcs'.
380
return os.environ['COMPUTERNAME'].decode("mbcs")
385
def _ensure_unicode(s):
386
from bzrlib import osutils
387
if s and type(s) != unicode:
388
from bzrlib import osutils
389
s = s.decode(osutils.get_user_encoding())
393
def get_appdata_location_unicode():
394
return _ensure_unicode(get_appdata_location())
396
def get_home_location_unicode():
397
return _ensure_unicode(get_home_location())
399
def get_user_name_unicode():
400
return _ensure_unicode(get_user_name())
402
def get_host_name_unicode():
403
return _ensure_unicode(get_host_name())
406
def _ensure_with_dir(path):
407
if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
408
return u'./' + path, True
412
def _undo_ensure_with_dir(path, corrected):
420
def glob_expand(file_list):
421
"""Replacement for glob expansion by the shell.
423
Win32's cmd.exe does not do glob expansion (eg ``*.py``), so we do our own
426
:param file_list: A list of filenames which may include shell globs.
427
:return: An expanded list of filenames.
429
Introduced in bzrlib 0.18.
434
expanded_file_list = []
435
for possible_glob in file_list:
437
# work around bugs in glob.glob()
438
# - Python bug #1001604 ("glob doesn't return unicode with ...")
439
# - failing expansion for */* with non-iso-8859-* chars
440
possible_glob, corrected = _ensure_with_dir(possible_glob)
441
glob_files = glob.glob(possible_glob)
444
# special case to let the normal code path handle
445
# files that do not exists
446
expanded_file_list.append(
447
_undo_ensure_with_dir(possible_glob, corrected))
449
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
450
expanded_file_list += glob_files
452
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
455
def get_app_path(appname):
456
"""Look up in Windows registry for full path to application executable.
457
Typicaly, applications create subkey with their basename
458
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
460
:param appname: name of application (if no filename extension
461
is specified, .exe used)
462
:return: full path to aplication executable from registry,
463
or appname itself if nothing found.
467
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
468
r'SOFTWARE\Microsoft\Windows'
469
r'\CurrentVersion\App Paths')
470
except EnvironmentError:
474
if not os.path.splitext(basename)[1]:
475
basename = appname + '.exe'
478
fullpath = _winreg.QueryValue(hkey, basename)
482
_winreg.CloseKey(hkey)
487
def set_file_attr_hidden(path):
488
"""Set file attributes to hidden if possible"""
490
win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
added
removed
bzrlib/win32utils.py
