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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
85
WIN32_STDIN_HANDLE = -10
86
WIN32_STDOUT_HANDLE = -11
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'
147
trace.note('WorkingSize %8d kB', info['WorkingSetSize'] / 1024)
148
trace.note('PeakWorking %8d kB', info['PeakWorkingSetSize'] / 1024)
151
trace.note('PagefileUsage %8d kB', info.get('PagefileUsage', 0) / 1024)
152
trace.note('PeakPagefileUsage %8d kB', info.get('PeakPagefileUsage', 0) / 1024)
153
trace.note('PrivateUsage %8d kB', info.get('PrivateUsage', 0) / 1024)
154
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
157
def get_console_size(defaultx=80, defaulty=25):
158
"""Return size of current console.
160
This function try to determine actual size of current working
161
console window and return tuple (sizex, sizey) if success,
162
or default size (defaultx, defaulty) otherwise.
166
return (defaultx, defaulty)
168
# To avoid problem with redirecting output via pipe
169
# need to use stderr instead of stdout
170
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
171
csbi = ctypes.create_string_buffer(22)
172
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
175
(bufx, bufy, curx, cury, wattr,
176
left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
177
sizex = right - left + 1
178
sizey = bottom - top + 1
179
return (sizex, sizey)
181
return (defaultx, defaulty)
184
def _get_sh_special_folder_path(csidl):
185
"""Call SHGetSpecialFolderPathW if available, or return None.
187
Result is always unicode (or None).
191
SHGetSpecialFolderPath = \
192
ctypes.windll.shell32.SHGetSpecialFolderPathW
193
except AttributeError:
196
buf = ctypes.create_unicode_buffer(MAX_PATH)
197
if SHGetSpecialFolderPath(None,buf,csidl,0):
200
global has_win32com_shell
201
if has_win32com_shell is None:
203
from win32com.shell import shell
204
has_win32com_shell = True
206
has_win32com_shell = False
207
if has_win32com_shell:
208
# still need to bind the name locally, but this is fast.
209
from win32com.shell import shell
211
return shell.SHGetSpecialFolderPath(0, csidl, 0)
213
# possibly E_NOTIMPL meaning we can't load the function pointer,
214
# or E_FAIL meaning the function failed - regardless, just ignore it
219
def get_appdata_location():
220
"""Return Application Data location.
221
Return None if we cannot obtain location.
223
Windows defines two 'Application Data' folders per user - a 'roaming'
224
one that moves with the user as they logon to different machines, and
225
a 'local' one that stays local to the machine. This returns the 'roaming'
226
directory, and thus is suitable for storing user-preferences, etc.
228
Returned value can be unicode or plain string.
229
To convert plain string to unicode use
230
s.decode(osutils.get_user_encoding())
231
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
233
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
237
appdata = os.environ.get('APPDATA')
240
# if we fall to this point we on win98
241
# at least try C:/WINDOWS/Application Data
242
windir = os.environ.get('windir')
244
appdata = os.path.join(windir, 'Application Data')
245
if os.path.isdir(appdata):
247
# did not find anything
251
def get_local_appdata_location():
252
"""Return Local Application Data location.
253
Return the same as get_appdata_location() if we cannot obtain location.
255
Windows defines two 'Application Data' folders per user - a 'roaming'
256
one that moves with the user as they logon to different machines, and
257
a 'local' one that stays local to the machine. This returns the 'local'
258
directory, and thus is suitable for caches, temp files and other things
259
which don't need to move with the user.
261
Returned value can be unicode or plain string.
262
To convert plain string to unicode use
263
s.decode(bzrlib.user_encoding)
264
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
266
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
269
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
270
local = os.environ.get('LOCALAPPDATA')
273
return get_appdata_location()
276
def get_home_location():
277
"""Return user's home location.
278
Assume on win32 it's the <My Documents> folder.
279
If location cannot be obtained return system drive root,
282
Returned value can be unicode or plain sring.
283
To convert plain string to unicode use
284
s.decode(osutils.get_user_encoding())
286
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
289
# try for HOME env variable
290
home = os.path.expanduser('~')
293
# at least return windows root directory
294
windir = os.environ.get('windir')
296
return os.path.splitdrive(windir)[0] + '/'
297
# otherwise C:\ is good enough for 98% users
302
"""Return user name as login name.
303
If name cannot be obtained return None.
305
Returned value can be unicode or plain sring.
306
To convert plain string to unicode use
307
s.decode(osutils.get_user_encoding())
311
advapi32 = ctypes.windll.advapi32
312
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
313
except AttributeError:
316
buf = create_buffer(UNLEN+1)
317
n = ctypes.c_int(UNLEN+1)
318
if GetUserName(buf, ctypes.byref(n)):
320
# otherwise try env variables
321
return os.environ.get('USERNAME', None)
324
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
325
# computer or the cluster associated with the local computer."
326
_WIN32_ComputerNameDnsHostname = 1
329
"""Return host machine name.
330
If name cannot be obtained return None.
332
:return: A unicode string representing the host name. On win98, this may be
333
a plain string as win32 api doesn't support unicode.
337
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
338
except (NotImplementedError, win32api.error):
339
# NotImplemented will happen on win9x...
343
kernel32 = ctypes.windll.kernel32
344
except AttributeError:
345
pass # Missing the module we need
347
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
348
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
350
# Try GetComputerNameEx which gives a proper Unicode hostname
351
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
353
if (GetComputerNameEx is not None
354
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
355
buf, ctypes.byref(n))):
358
# Try GetComputerName in case GetComputerNameEx wasn't found
359
# It returns the NETBIOS name, which isn't as good, but still ok.
360
# The first GetComputerNameEx might have changed 'n', so reset it
361
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
362
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
364
if (GetComputerName is not None
365
and GetComputerName(buf, ctypes.byref(n))):
367
# otherwise try env variables, which will be 'mbcs' encoded
368
# on Windows (Python doesn't expose the native win32 unicode environment)
370
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
371
# environment variables should always be encoded in 'mbcs'.
373
return os.environ['COMPUTERNAME'].decode("mbcs")
378
def _ensure_unicode(s):
379
from bzrlib import osutils
380
if s and type(s) != unicode:
381
from bzrlib import osutils
382
s = s.decode(osutils.get_user_encoding())
386
def get_appdata_location_unicode():
387
return _ensure_unicode(get_appdata_location())
389
def get_home_location_unicode():
390
return _ensure_unicode(get_home_location())
392
def get_user_name_unicode():
393
return _ensure_unicode(get_user_name())
395
def get_host_name_unicode():
396
return _ensure_unicode(get_host_name())
399
def _ensure_with_dir(path):
400
if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
401
return u'./' + path, True
405
def _undo_ensure_with_dir(path, corrected):
413
def glob_expand(file_list):
414
"""Replacement for glob expansion by the shell.
416
Win32's cmd.exe does not do glob expansion (eg ``*.py``), so we do our own
419
:param file_list: A list of filenames which may include shell globs.
420
:return: An expanded list of filenames.
422
Introduced in bzrlib 0.18.
427
expanded_file_list = []
428
for possible_glob in file_list:
430
# work around bugs in glob.glob()
431
# - Python bug #1001604 ("glob doesn't return unicode with ...")
432
# - failing expansion for */* with non-iso-8859-* chars
433
possible_glob, corrected = _ensure_with_dir(possible_glob)
434
glob_files = glob.glob(possible_glob)
437
# special case to let the normal code path handle
438
# files that do not exists
439
expanded_file_list.append(
440
_undo_ensure_with_dir(possible_glob, corrected))
442
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
443
expanded_file_list += glob_files
445
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
448
def get_app_path(appname):
449
"""Look up in Windows registry for full path to application executable.
450
Typicaly, applications create subkey with their basename
451
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
453
:param appname: name of application (if no filename extension
454
is specified, .exe used)
455
:return: full path to aplication executable from registry,
456
or appname itself if nothing found.
460
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
461
r'SOFTWARE\Microsoft\Windows'
462
r'\CurrentVersion\App Paths')
463
except EnvironmentError:
467
if not os.path.splitext(basename)[1]:
468
basename = appname + '.exe'
471
fullpath = _winreg.QueryValue(hkey, basename)
475
_winreg.CloseKey(hkey)
480
def set_file_attr_hidden(path):
481
"""Set file attributes to hidden if possible"""
483
win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
added
removed
bzrlib/win32utils.py
