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
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
99
# Registry data type ids
104
def debug_memory_win32api(message='', short=True):
105
"""Use trace.note() to dump the running memory info."""
106
from bzrlib import trace
108
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
109
"""Used by GetProcessMemoryInfo"""
110
_fields_ = [('cb', ctypes.c_ulong),
111
('PageFaultCount', ctypes.c_ulong),
112
('PeakWorkingSetSize', ctypes.c_size_t),
113
('WorkingSetSize', ctypes.c_size_t),
114
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
115
('QuotaPagedPoolUsage', ctypes.c_size_t),
116
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
117
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
118
('PagefileUsage', ctypes.c_size_t),
119
('PeakPagefileUsage', ctypes.c_size_t),
120
('PrivateUsage', ctypes.c_size_t),
122
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
123
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
124
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
125
ctypes.byref(mem_struct),
126
ctypes.sizeof(mem_struct))
128
trace.note('Failed to GetProcessMemoryInfo()')
130
info = {'PageFaultCount': mem_struct.PageFaultCount,
131
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
132
'WorkingSetSize': mem_struct.WorkingSetSize,
133
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
134
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
135
'QuotaPeakNonPagedPoolUsage': mem_struct.QuotaPeakNonPagedPoolUsage,
136
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
137
'PagefileUsage': mem_struct.PagefileUsage,
138
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
139
'PrivateUsage': mem_struct.PrivateUsage,
143
# win32process does not return PrivateUsage, because it doesn't use
144
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
145
proc = win32process.GetCurrentProcess()
146
info = win32process.GetProcessMemoryInfo(proc)
148
trace.note('Cannot debug memory on win32 without ctypes'
152
trace.note('WorkingSize %7dKB'
153
'\tPeakWorking %7dKB\t%s',
154
info['WorkingSetSize'] / 1024,
155
info['PeakWorkingSetSize'] / 1024,
159
trace.note('%s', message)
160
trace.note('WorkingSize %8d KB', info['WorkingSetSize'] / 1024)
161
trace.note('PeakWorking %8d KB', info['PeakWorkingSetSize'] / 1024)
162
trace.note('PagefileUsage %8d KB', info.get('PagefileUsage', 0) / 1024)
163
trace.note('PeakPagefileUsage %8d KB', info.get('PeakPagefileUsage', 0) / 1024)
164
trace.note('PrivateUsage %8d KB', info.get('PrivateUsage', 0) / 1024)
165
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
168
def get_console_size(defaultx=80, defaulty=25):
169
"""Return size of current console.
171
This function try to determine actual size of current working
172
console window and return tuple (sizex, sizey) if success,
173
or default size (defaultx, defaulty) otherwise.
177
return (defaultx, defaulty)
179
# To avoid problem with redirecting output via pipe
180
# need to use stderr instead of stdout
181
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
182
csbi = ctypes.create_string_buffer(22)
183
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
186
(bufx, bufy, curx, cury, wattr,
187
left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
188
sizex = right - left + 1
189
sizey = bottom - top + 1
190
return (sizex, sizey)
192
return (defaultx, defaulty)
195
def _get_sh_special_folder_path(csidl):
196
"""Call SHGetSpecialFolderPathW if available, or return None.
198
Result is always unicode (or None).
202
SHGetSpecialFolderPath = \
203
ctypes.windll.shell32.SHGetSpecialFolderPathW
204
except AttributeError:
207
buf = ctypes.create_unicode_buffer(MAX_PATH)
208
if SHGetSpecialFolderPath(None,buf,csidl,0):
211
global has_win32com_shell
212
if has_win32com_shell is None:
214
from win32com.shell import shell
215
has_win32com_shell = True
217
has_win32com_shell = False
218
if has_win32com_shell:
219
# still need to bind the name locally, but this is fast.
220
from win32com.shell import shell
222
return shell.SHGetSpecialFolderPath(0, csidl, 0)
224
# possibly E_NOTIMPL meaning we can't load the function pointer,
225
# or E_FAIL meaning the function failed - regardless, just ignore it
230
def get_appdata_location():
231
"""Return Application Data location.
232
Return None if we cannot obtain location.
234
Windows defines two 'Application Data' folders per user - a 'roaming'
235
one that moves with the user as they logon to different machines, and
236
a 'local' one that stays local to the machine. This returns the 'roaming'
237
directory, and thus is suitable for storing user-preferences, etc.
239
Returned value can be unicode or plain string.
240
To convert plain string to unicode use
241
s.decode(osutils.get_user_encoding())
242
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
244
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
248
appdata = os.environ.get('APPDATA')
251
# if we fall to this point we on win98
252
# at least try C:/WINDOWS/Application Data
253
windir = os.environ.get('windir')
255
appdata = os.path.join(windir, 'Application Data')
256
if os.path.isdir(appdata):
258
# did not find anything
262
def get_local_appdata_location():
263
"""Return Local Application Data location.
264
Return the same as get_appdata_location() if we cannot obtain location.
266
Windows defines two 'Application Data' folders per user - a 'roaming'
267
one that moves with the user as they logon to different machines, and
268
a 'local' one that stays local to the machine. This returns the 'local'
269
directory, and thus is suitable for caches, temp files and other things
270
which don't need to move with the user.
272
Returned value can be unicode or plain string.
273
To convert plain string to unicode use
274
s.decode(osutils.get_user_encoding())
275
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
277
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
280
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
281
local = os.environ.get('LOCALAPPDATA')
284
return get_appdata_location()
287
def get_home_location():
288
"""Return user's home location.
289
Assume on win32 it's the <My Documents> folder.
290
If location cannot be obtained return system drive root,
293
Returned value can be unicode or plain string.
294
To convert plain string to unicode use
295
s.decode(osutils.get_user_encoding())
297
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
300
# try for HOME env variable
301
home = os.path.expanduser('~')
304
# at least return windows root directory
305
windir = os.environ.get('windir')
307
return os.path.splitdrive(windir)[0] + '/'
308
# otherwise C:\ is good enough for 98% users
313
"""Return user name as login name.
314
If name cannot be obtained return None.
316
Returned value can be unicode or plain string.
317
To convert plain string to unicode use
318
s.decode(osutils.get_user_encoding())
322
advapi32 = ctypes.windll.advapi32
323
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
324
except AttributeError:
327
buf = create_buffer(UNLEN+1)
328
n = ctypes.c_int(UNLEN+1)
329
if GetUserName(buf, ctypes.byref(n)):
331
# otherwise try env variables
332
return os.environ.get('USERNAME', None)
335
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
336
# computer or the cluster associated with the local computer."
337
_WIN32_ComputerNameDnsHostname = 1
340
"""Return host machine name.
341
If name cannot be obtained return None.
343
:return: A unicode string representing the host name. On win98, this may be
344
a plain string as win32 api doesn't support unicode.
348
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
349
except (NotImplementedError, win32api.error):
350
# NotImplemented will happen on win9x...
354
kernel32 = ctypes.windll.kernel32
355
except AttributeError:
356
pass # Missing the module we need
358
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
359
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
361
# Try GetComputerNameEx which gives a proper Unicode hostname
362
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
364
if (GetComputerNameEx is not None
365
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
366
buf, ctypes.byref(n))):
369
# Try GetComputerName in case GetComputerNameEx wasn't found
370
# It returns the NETBIOS name, which isn't as good, but still ok.
371
# The first GetComputerNameEx might have changed 'n', so reset it
372
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
373
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
375
if (GetComputerName is not None
376
and GetComputerName(buf, ctypes.byref(n))):
378
# otherwise try env variables, which will be 'mbcs' encoded
379
# on Windows (Python doesn't expose the native win32 unicode environment)
381
# http://msdn.microsoft.com/en-us/library/aa246807.aspx
382
# environment variables should always be encoded in 'mbcs'.
384
return os.environ['COMPUTERNAME'].decode("mbcs")
389
def _ensure_unicode(s):
390
from bzrlib import osutils
391
if s and type(s) != unicode:
392
from bzrlib import osutils
393
s = s.decode(osutils.get_user_encoding())
397
def get_appdata_location_unicode():
398
return _ensure_unicode(get_appdata_location())
400
def get_home_location_unicode():
401
return _ensure_unicode(get_home_location())
403
def get_user_name_unicode():
404
return _ensure_unicode(get_user_name())
406
def get_host_name_unicode():
407
return _ensure_unicode(get_host_name())
410
def _ensure_with_dir(path):
411
if not os.path.split(path)[0] or path.startswith(u'*') or path.startswith(u'?'):
412
return u'./' + path, True
416
def _undo_ensure_with_dir(path, corrected):
424
def glob_expand(file_list):
425
"""Replacement for glob expansion by the shell.
427
Win32's cmd.exe does not do glob expansion (eg ``*.py``), so we do our own
430
:param file_list: A list of filenames which may include shell globs.
431
:return: An expanded list of filenames.
433
Introduced in bzrlib 0.18.
438
expanded_file_list = []
439
for possible_glob in file_list:
440
# work around bugs in glob.glob()
441
# - Python bug #1001604 ("glob doesn't return unicode with ...")
442
# - failing expansion for */* with non-iso-8859-* chars
443
possible_glob, corrected = _ensure_with_dir(possible_glob)
444
glob_files = glob.glob(possible_glob)
447
# special case to let the normal code path handle
448
# files that do not exists
449
expanded_file_list.append(
450
_undo_ensure_with_dir(possible_glob, corrected))
452
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
453
expanded_file_list += glob_files
455
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
458
def get_app_path(appname):
459
"""Look up in Windows registry for full path to application executable.
460
Typically, applications create subkey with their basename
461
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
463
:param appname: name of application (if no filename extension
464
is specified, .exe used)
465
:return: full path to aplication executable from registry,
466
or appname itself if nothing found.
471
if not os.path.splitext(basename)[1]:
472
basename = appname + '.exe'
475
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
476
'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
478
except EnvironmentError:
483
path, type_id = _winreg.QueryValueEx(hkey, '')
487
_winreg.CloseKey(hkey)
489
if type_id == REG_SZ:
491
if type_id == REG_EXPAND_SZ and has_win32api:
492
fullpath = win32api.ExpandEnvironmentStrings(path)
493
if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
494
fullpath = fullpath[1:-1] # remove quotes around value
499
def set_file_attr_hidden(path):
500
"""Set file attributes to hidden if possible"""
502
win32file.SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
505
if has_ctypes and winver != 'Windows 98':
506
def get_unicode_argv():
507
LPCWSTR = ctypes.c_wchar_p
509
POINTER = ctypes.POINTER
510
prototype = ctypes.WINFUNCTYPE(LPCWSTR)
511
GetCommandLine = prototype(("GetCommandLineW",
512
ctypes.windll.kernel32))
513
prototype = ctypes.WINFUNCTYPE(POINTER(LPCWSTR), LPCWSTR, POINTER(INT))
514
CommandLineToArgv = prototype(("CommandLineToArgvW",
515
ctypes.windll.shell32))
517
pargv = CommandLineToArgv(GetCommandLine(), ctypes.byref(c))
518
# Skip the first argument, since we only care about parameters
519
argv = [pargv[i] for i in range(1, c.value)]
520
if getattr(sys, 'frozen', None) is None:
521
# Invoked via 'python.exe' which takes the form:
522
# python.exe [PYTHON_OPTIONS] C:\Path\bzr [BZR_OPTIONS]
523
# we need to get only BZR_OPTIONS part,
524
# so let's using sys.argv[1:] as reference to get the tail
526
tail_len = len(sys.argv[1:])
527
ix = len(argv) - tail_len
531
get_unicode_argv = None
added
removed
bzrlib/win32utils.py
