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
79
# pulling in win32com.shell is a bit of overhead, and normally we don't need
80
# it as ctypes is preferred and common. lazy_imports and "optional"
81
# modules don't work well, so we do our own lazy thing...
82
has_win32com_shell = None # Set to True or False once we know for sure...
84
# Special Win32 API constants
85
# Handles of std streams
86
WIN32_STDIN_HANDLE = -10
87
WIN32_STDOUT_HANDLE = -11
88
WIN32_STDERR_HANDLE = -12
90
# CSIDL constants (from MSDN 2003)
91
CSIDL_APPDATA = 0x001A # Application Data folder
92
CSIDL_LOCAL_APPDATA = 0x001c# <user name>\Local Settings\Application Data (non roaming)
93
CSIDL_PERSONAL = 0x0005 # My Documents folder
95
# from winapi C headers
98
MAX_COMPUTERNAME_LENGTH = 31
100
# Registry data type ids
105
def debug_memory_win32api(message='', short=True):
106
"""Use trace.note() to dump the running memory info."""
107
from bzrlib import trace
109
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
110
"""Used by GetProcessMemoryInfo"""
111
_fields_ = [('cb', ctypes.c_ulong),
112
('PageFaultCount', ctypes.c_ulong),
113
('PeakWorkingSetSize', ctypes.c_size_t),
114
('WorkingSetSize', ctypes.c_size_t),
115
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
116
('QuotaPagedPoolUsage', ctypes.c_size_t),
117
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
118
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
119
('PagefileUsage', ctypes.c_size_t),
120
('PeakPagefileUsage', ctypes.c_size_t),
121
('PrivateUsage', ctypes.c_size_t),
123
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
124
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
125
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
126
ctypes.byref(mem_struct),
127
ctypes.sizeof(mem_struct))
129
trace.note('Failed to GetProcessMemoryInfo()')
131
info = {'PageFaultCount': mem_struct.PageFaultCount,
132
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
133
'WorkingSetSize': mem_struct.WorkingSetSize,
134
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
135
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
136
'QuotaPeakNonPagedPoolUsage': mem_struct.QuotaPeakNonPagedPoolUsage,
137
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
138
'PagefileUsage': mem_struct.PagefileUsage,
139
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
140
'PrivateUsage': mem_struct.PrivateUsage,
144
# win32process does not return PrivateUsage, because it doesn't use
145
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
146
proc = win32process.GetCurrentProcess()
147
info = win32process.GetProcessMemoryInfo(proc)
149
trace.note('Cannot debug memory on win32 without ctypes'
153
trace.note('WorkingSize %7dKB'
154
'\tPeakWorking %7dKB\t%s',
155
info['WorkingSetSize'] / 1024,
156
info['PeakWorkingSetSize'] / 1024,
160
trace.note('%s', message)
161
trace.note('WorkingSize %8d KB', info['WorkingSetSize'] / 1024)
162
trace.note('PeakWorking %8d KB', info['PeakWorkingSetSize'] / 1024)
163
trace.note('PagefileUsage %8d KB', info.get('PagefileUsage', 0) / 1024)
164
trace.note('PeakPagefileUsage %8d KB', info.get('PeakPagefileUsage', 0) / 1024)
165
trace.note('PrivateUsage %8d KB', info.get('PrivateUsage', 0) / 1024)
166
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
169
def get_console_size(defaultx=80, defaulty=25):
170
"""Return size of current console.
172
This function try to determine actual size of current working
173
console window and return tuple (sizex, sizey) if success,
174
or default size (defaultx, defaulty) otherwise.
178
return (defaultx, defaulty)
180
# To avoid problem with redirecting output via pipe
181
# need to use stderr instead of stdout
182
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
183
csbi = ctypes.create_string_buffer(22)
184
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
187
(bufx, bufy, curx, cury, wattr,
188
left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
189
sizex = right - left + 1
190
sizey = bottom - top + 1
191
return (sizex, sizey)
193
return (defaultx, defaulty)
196
def _get_sh_special_folder_path(csidl):
197
"""Call SHGetSpecialFolderPathW if available, or return None.
199
Result is always unicode (or None).
203
SHGetSpecialFolderPath = \
204
ctypes.windll.shell32.SHGetSpecialFolderPathW
205
except AttributeError:
208
buf = ctypes.create_unicode_buffer(MAX_PATH)
209
if SHGetSpecialFolderPath(None,buf,csidl,0):
212
global has_win32com_shell
213
if has_win32com_shell is None:
215
from win32com.shell import shell
216
has_win32com_shell = True
218
has_win32com_shell = False
219
if has_win32com_shell:
220
# still need to bind the name locally, but this is fast.
221
from win32com.shell import shell
223
return shell.SHGetSpecialFolderPath(0, csidl, 0)
225
# possibly E_NOTIMPL meaning we can't load the function pointer,
226
# or E_FAIL meaning the function failed - regardless, just ignore it
231
def get_appdata_location():
232
"""Return Application Data location.
233
Return None if we cannot obtain location.
235
Windows defines two 'Application Data' folders per user - a 'roaming'
236
one that moves with the user as they logon to different machines, and
237
a 'local' one that stays local to the machine. This returns the 'roaming'
238
directory, and thus is suitable for storing user-preferences, etc.
240
Returned value can be unicode or plain string.
241
To convert plain string to unicode use
242
s.decode(osutils.get_user_encoding())
243
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
245
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
249
appdata = os.environ.get('APPDATA')
252
# if we fall to this point we on win98
253
# at least try C:/WINDOWS/Application Data
254
windir = os.environ.get('windir')
256
appdata = os.path.join(windir, 'Application Data')
257
if os.path.isdir(appdata):
259
# did not find anything
263
def get_local_appdata_location():
264
"""Return Local Application Data location.
265
Return the same as get_appdata_location() if we cannot obtain location.
267
Windows defines two 'Application Data' folders per user - a 'roaming'
268
one that moves with the user as they logon to different machines, and
269
a 'local' one that stays local to the machine. This returns the 'local'
270
directory, and thus is suitable for caches, temp files and other things
271
which don't need to move with the user.
273
Returned value can be unicode or plain string.
274
To convert plain string to unicode use
275
s.decode(osutils.get_user_encoding())
276
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
278
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
281
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
282
local = os.environ.get('LOCALAPPDATA')
285
return get_appdata_location()
288
def get_home_location():
289
"""Return user's home location.
290
Assume on win32 it's the <My Documents> folder.
291
If location cannot be obtained return system drive root,
294
Returned value can be unicode or plain string.
295
To convert plain string to unicode use
296
s.decode(osutils.get_user_encoding())
298
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
301
# try for HOME env variable
302
home = os.path.expanduser('~')
305
# at least return windows root directory
306
windir = os.environ.get('windir')
308
return os.path.splitdrive(windir)[0] + '/'
309
# otherwise C:\ is good enough for 98% users
314
"""Return user name as login name.
315
If name cannot be obtained return None.
317
Returned value can be unicode or plain string.
318
To convert plain string to unicode use
319
s.decode(osutils.get_user_encoding())
323
advapi32 = ctypes.windll.advapi32
324
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
325
except AttributeError:
328
buf = create_buffer(UNLEN+1)
329
n = ctypes.c_int(UNLEN+1)
330
if GetUserName(buf, ctypes.byref(n)):
332
# otherwise try env variables
333
return os.environ.get('USERNAME', None)
336
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
337
# computer or the cluster associated with the local computer."
338
_WIN32_ComputerNameDnsHostname = 1
341
"""Return host machine name.
342
If name cannot be obtained return None.
344
:return: A unicode string representing the host name. On win98, this may be
345
a plain string as win32 api doesn't support unicode.
349
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
350
except (NotImplementedError, win32api.error):
351
# NotImplemented will happen on win9x...
355
kernel32 = ctypes.windll.kernel32
356
except AttributeError:
357
pass # Missing the module we need
359
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
360
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
362
# Try GetComputerNameEx which gives a proper Unicode hostname
363
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
365
if (GetComputerNameEx is not None
366
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
367
buf, ctypes.byref(n))):
370
# Try GetComputerName in case GetComputerNameEx wasn't found
371
# It returns the NETBIOS name, which isn't as good, but still ok.
372
# The first GetComputerNameEx might have changed 'n', so reset it
373
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
374
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
376
if (GetComputerName is not None
377
and GetComputerName(buf, ctypes.byref(n))):
379
# otherwise try env variables, which will be 'mbcs' encoded
380
# on Windows (Python doesn't expose the native win32 unicode environment)
382
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
383
# environment variables should always be encoded in 'mbcs'.
385
return os.environ['COMPUTERNAME'].decode("mbcs")
390
def _ensure_unicode(s):
391
from bzrlib import osutils
392
if s and type(s) != unicode:
393
from bzrlib import osutils
394
s = s.decode(osutils.get_user_encoding())
398
def get_appdata_location_unicode():
399
return _ensure_unicode(get_appdata_location())
401
def get_home_location_unicode():
402
return _ensure_unicode(get_home_location())
404
def get_user_name_unicode():
405
return _ensure_unicode(get_user_name())
407
def get_host_name_unicode():
408
return _ensure_unicode(get_host_name())
411
def _ensure_with_dir(path):
412
if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
413
return u'./' + path, True
417
def _undo_ensure_with_dir(path, corrected):
425
def glob_expand(file_list):
426
"""Replacement for glob expansion by the shell.
428
Win32's cmd.exe does not do glob expansion (eg ``*.py``), so we do our own
431
:param file_list: A list of filenames which may include shell globs.
432
:return: An expanded list of filenames.
434
Introduced in bzrlib 0.18.
439
expanded_file_list = []
440
for possible_glob in file_list:
441
# work around bugs in glob.glob()
442
# - Python bug #1001604 ("glob doesn't return unicode with ...")
443
# - failing expansion for */* with non-iso-8859-* chars
444
possible_glob, corrected = _ensure_with_dir(possible_glob)
445
glob_files = glob.glob(possible_glob)
448
# special case to let the normal code path handle
449
# files that do not exists
450
expanded_file_list.append(
451
_undo_ensure_with_dir(possible_glob, corrected))
453
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
454
expanded_file_list += glob_files
456
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
459
def get_app_path(appname):
460
"""Look up in Windows registry for full path to application executable.
461
Typically, applications create subkey with their basename
462
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
464
:param appname: name of application (if no filename extension
465
is specified, .exe used)
466
:return: full path to aplication executable from registry,
467
or appname itself if nothing found.
472
if not os.path.splitext(basename)[1]:
473
basename = appname + '.exe'
476
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
477
'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
479
except EnvironmentError:
484
path, type_id = _winreg.QueryValueEx(hkey, '')
488
_winreg.CloseKey(hkey)
490
if type_id == REG_SZ:
492
if type_id == REG_EXPAND_SZ and has_win32api:
493
fullpath = win32api.ExpandEnvironmentStrings(path)
494
if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
495
fullpath = fullpath[1:-1] # remove quotes around value
500
def set_file_attr_hidden(path):
501
"""Set file attributes to hidden if possible"""
503
if winver != 'Windows 98':
504
SetFileAttributes = win32file.SetFileAttributesW
506
SetFileAttributes = win32file.SetFileAttributes
508
SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
509
except pywintypes.error, e:
510
from bzrlib import trace
511
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
514
if has_ctypes and winver != 'Windows 98':
515
def get_unicode_argv():
516
LPCWSTR = ctypes.c_wchar_p
518
POINTER = ctypes.POINTER
519
prototype = ctypes.WINFUNCTYPE(LPCWSTR)
520
GetCommandLine = prototype(("GetCommandLineW",
521
ctypes.windll.kernel32))
522
prototype = ctypes.WINFUNCTYPE(POINTER(LPCWSTR), LPCWSTR, POINTER(INT))
523
CommandLineToArgv = prototype(("CommandLineToArgvW",
524
ctypes.windll.shell32))
526
pargv = CommandLineToArgv(GetCommandLine(), ctypes.byref(c))
527
# Skip the first argument, since we only care about parameters
528
argv = [pargv[i] for i in range(1, c.value)]
529
if getattr(sys, 'frozen', None) is None:
530
# Invoked via 'python.exe' which takes the form:
531
# python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
532
# we need to get only BZR_OPTIONS part,
533
# so let's using sys.argv[1:] as reference to get the tail
535
tail_len = len(sys.argv[1:])
536
ix = len(argv) - tail_len
540
get_unicode_argv = None
added
removed
bzrlib/win32utils.py
