13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Win32-specific helper functions
19
19
Only one dependency: ctypes should be installed.
27
from bzrlib import cmdline
28
30
if sys.platform == 'win32':
82
100
MAX_COMPUTERNAME_LENGTH = 31
102
# Registry data type ids
107
def debug_memory_win32api(message='', short=True):
108
"""Use trace.note() to dump the running memory info."""
109
from bzrlib import trace
111
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
112
"""Used by GetProcessMemoryInfo"""
113
_fields_ = [('cb', ctypes.c_ulong),
114
('PageFaultCount', ctypes.c_ulong),
115
('PeakWorkingSetSize', ctypes.c_size_t),
116
('WorkingSetSize', ctypes.c_size_t),
117
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
118
('QuotaPagedPoolUsage', ctypes.c_size_t),
119
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
120
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
121
('PagefileUsage', ctypes.c_size_t),
122
('PeakPagefileUsage', ctypes.c_size_t),
123
('PrivateUsage', ctypes.c_size_t),
125
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
126
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
127
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
128
ctypes.byref(mem_struct),
129
ctypes.sizeof(mem_struct))
131
trace.note('Failed to GetProcessMemoryInfo()')
133
info = {'PageFaultCount': mem_struct.PageFaultCount,
134
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
135
'WorkingSetSize': mem_struct.WorkingSetSize,
136
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
137
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
138
'QuotaPeakNonPagedPoolUsage':
139
mem_struct.QuotaPeakNonPagedPoolUsage,
140
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
141
'PagefileUsage': mem_struct.PagefileUsage,
142
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
143
'PrivateUsage': mem_struct.PrivateUsage,
147
# win32process does not return PrivateUsage, because it doesn't use
148
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
149
proc = win32process.GetCurrentProcess()
150
info = win32process.GetProcessMemoryInfo(proc)
152
trace.note('Cannot debug memory on win32 without ctypes'
156
# using base-2 units (see HACKING.txt).
157
trace.note('WorkingSize %7dKiB'
158
'\tPeakWorking %7dKiB\t%s',
159
info['WorkingSetSize'] / 1024,
160
info['PeakWorkingSetSize'] / 1024,
164
trace.note('%s', message)
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',
169
info.get('PeakPagefileUsage', 0) / 1024)
170
trace.note('PrivateUsage %8d KiB', info.get('PrivateUsage', 0) / 1024)
171
trace.note('PageFaultCount %8d', info.get('PageFaultCount', 0))
85
174
def get_console_size(defaultx=80, defaulty=25):
86
175
"""Return size of current console.
94
183
return (defaultx, defaulty)
96
185
# To avoid problem with redirecting output via pipe
97
# need to use stderr instead of stdout
186
# we need to use stderr instead of stdout
98
187
h = ctypes.windll.kernel32.GetStdHandle(WIN32_STDERR_HANDLE)
99
188
csbi = ctypes.create_string_buffer(22)
100
189
res = ctypes.windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
103
192
(bufx, bufy, curx, cury, wattr,
104
left, top, right, bottom, maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
193
left, top, right, bottom, maxx, maxy) = struct.unpack(
194
"hhhhHhhhhhh", csbi.raw)
105
195
sizex = right - left + 1
106
196
sizey = bottom - top + 1
107
197
return (sizex, sizey)
109
199
return (defaultx, defaulty)
202
def _get_sh_special_folder_path(csidl):
203
"""Call SHGetSpecialFolderPathW if available, or return None.
205
Result is always unicode (or None).
209
SHGetSpecialFolderPath = \
210
ctypes.windll.shell32.SHGetSpecialFolderPathW
211
except AttributeError:
214
buf = ctypes.create_unicode_buffer(MAX_PATH)
215
if SHGetSpecialFolderPath(None,buf,csidl,0):
218
global has_win32com_shell
219
if has_win32com_shell is None:
221
from win32com.shell import shell
222
has_win32com_shell = True
224
has_win32com_shell = False
225
if has_win32com_shell:
226
# still need to bind the name locally, but this is fast.
227
from win32com.shell import shell
229
return shell.SHGetSpecialFolderPath(0, csidl, 0)
231
# possibly E_NOTIMPL meaning we can't load the function pointer,
232
# or E_FAIL meaning the function failed - regardless, just ignore it
112
237
def get_appdata_location():
113
238
"""Return Application Data location.
114
239
Return None if we cannot obtain location.
116
Returned value can be unicode or plain sring.
241
Windows defines two 'Application Data' folders per user - a 'roaming'
242
one that moves with the user as they logon to different machines, and
243
a 'local' one that stays local to the machine. This returns the 'roaming'
244
directory, and thus is suitable for storing user-preferences, etc.
246
Returned value can be unicode or plain string.
117
247
To convert plain string to unicode use
118
s.decode(bzrlib.user_encoding)
248
s.decode(osutils.get_user_encoding())
249
(XXX - but see bug 262874, which asserts the correct encoding is 'mbcs')
122
SHGetSpecialFolderPath = \
123
ctypes.windll.shell32.SHGetSpecialFolderPathW
124
except AttributeError:
127
buf = ctypes.create_unicode_buffer(MAX_PATH)
128
if SHGetSpecialFolderPath(None,buf,CSIDL_APPDATA,0):
251
appdata = _get_sh_special_folder_path(CSIDL_APPDATA)
130
254
# from env variable
131
255
appdata = os.environ.get('APPDATA')
269
def get_local_appdata_location():
270
"""Return Local Application Data location.
271
Return the same as get_appdata_location() if we cannot obtain location.
273
Windows defines two 'Application Data' folders per user - a 'roaming'
274
one that moves with the user as they logon to different machines, and
275
a 'local' one that stays local to the machine. This returns the 'local'
276
directory, and thus is suitable for caches, temp files and other things
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')
284
local = _get_sh_special_folder_path(CSIDL_LOCAL_APPDATA)
287
# Vista supplies LOCALAPPDATA, but XP and earlier do not.
288
local = os.environ.get('LOCALAPPDATA')
291
return get_appdata_location()
145
294
def get_home_location():
146
295
"""Return user's home location.
147
296
Assume on win32 it's the <My Documents> folder.
148
297
If location cannot be obtained return system drive root,
151
Returned value can be unicode or plain sring.
300
Returned value can be unicode or plain string.
152
301
To convert plain string to unicode use
153
s.decode(bzrlib.user_encoding)
302
s.decode(osutils.get_user_encoding())
157
SHGetSpecialFolderPath = \
158
ctypes.windll.shell32.SHGetSpecialFolderPathW
159
except AttributeError:
162
buf = ctypes.create_unicode_buffer(MAX_PATH)
163
if SHGetSpecialFolderPath(None,buf,CSIDL_PERSONAL,0):
304
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
165
307
# try for HOME env variable
166
308
home = os.path.expanduser('~')
197
339
return os.environ.get('USERNAME', None)
342
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
343
# computer or the cluster associated with the local computer."
344
_WIN32_ComputerNameDnsHostname = 1
200
346
def get_host_name():
201
347
"""Return host machine name.
202
348
If name cannot be obtained return None.
204
Returned value can be unicode or plain sring.
205
To convert plain string to unicode use
206
s.decode(bzrlib.user_encoding)
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.
355
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
356
except (NotImplementedError, win32api.error):
357
# NotImplemented will happen on win9x...
210
361
kernel32 = ctypes.windll.kernel32
211
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix)
212
362
except AttributeError:
363
pass # Missing the module we need
215
365
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
216
366
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
217
if GetComputerName(buf, ctypes.byref(n)):
219
# otherwise try env variables
220
return os.environ.get('COMPUTERNAME', None)
368
# Try GetComputerNameEx which gives a proper Unicode hostname
369
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
371
if (GetComputerNameEx is not None
372
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
373
buf, ctypes.byref(n))):
376
# Try GetComputerName in case GetComputerNameEx wasn't found
377
# It returns the NETBIOS name, which isn't as good, but still ok.
378
# The first GetComputerNameEx might have changed 'n', so reset it
379
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
380
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
382
if (GetComputerName is not None
383
and GetComputerName(buf, ctypes.byref(n))):
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")
223
396
def _ensure_unicode(s):
224
397
if s and type(s) != unicode:
226
s = s.decode(bzrlib.user_encoding)
398
from bzrlib import osutils
399
s = s.decode(osutils.get_user_encoding())
230
403
def get_appdata_location_unicode():
231
404
return _ensure_unicode(get_appdata_location())
431
def glob_one(possible_glob):
432
"""Same as glob.glob().
434
work around bugs in glob.glob()
435
- Python bug #1001604 ("glob doesn't return unicode with ...")
436
- failing expansion for */* with non-iso-8859-* chars
438
corrected_glob, corrected = _ensure_with_dir(possible_glob)
439
glob_files = glob.glob(corrected_glob)
442
# special case to let the normal code path handle
443
# files that do not exist, etc.
444
glob_files = [possible_glob]
446
glob_files = [_undo_ensure_with_dir(elem, corrected)
447
for elem in glob_files]
448
return [elem.replace(u'\\', u'/') for elem in glob_files]
257
451
def glob_expand(file_list):
258
452
"""Replacement for glob expansion by the shell.
268
462
if not file_list:
271
464
expanded_file_list = []
272
465
for possible_glob in file_list:
274
# work around bugs in glob.glob()
275
# - Python bug #1001604 ("glob doesn't return unicode with ...")
276
# - failing expansion for */* with non-iso-8859-* chars
277
possible_glob, corrected = _ensure_with_dir(possible_glob)
278
glob_files = glob.glob(possible_glob)
281
# special case to let the normal code path handle
282
# files that do not exists
283
expanded_file_list.append(
284
_undo_ensure_with_dir(possible_glob, corrected))
286
glob_files = [_undo_ensure_with_dir(elem, corrected) for elem in glob_files]
287
expanded_file_list += glob_files
289
return [elem.replace(u'\\', u'/') for elem in expanded_file_list]
466
expanded_file_list.extend(glob_one(possible_glob))
467
return expanded_file_list
292
470
def get_app_path(appname):
293
471
"""Look up in Windows registry for full path to application executable.
294
Typicaly, applications create subkey with their basename
472
Typically, applications create subkey with their basename
295
473
in HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\
297
475
:param appname: name of application (if no filename extension
300
478
or appname itself if nothing found.
483
if not os.path.splitext(basename)[1]:
484
basename = appname + '.exe'
304
487
hkey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,
305
r'SOFTWARE\Microsoft\Windows'
306
r'\CurrentVersion\App Paths')
488
'SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\' +
307
490
except EnvironmentError:
311
if not os.path.splitext(basename)[1]:
312
basename = appname + '.exe'
315
fullpath = _winreg.QueryValue(hkey, basename)
495
path, type_id = _winreg.QueryValueEx(hkey, '')
316
496
except WindowsError:
319
499
_winreg.CloseKey(hkey)
501
if type_id == REG_SZ:
503
if type_id == REG_EXPAND_SZ and has_win32api:
504
fullpath = win32api.ExpandEnvironmentStrings(path)
505
if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
506
fullpath = fullpath[1:-1] # remove quotes around value
511
def set_file_attr_hidden(path):
512
"""Set file attributes to hidden if possible"""
514
if winver != 'Windows 98':
515
SetFileAttributes = win32file.SetFileAttributesW
517
SetFileAttributes = win32file.SetFileAttributes
519
SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
520
except pywintypes.error, e:
521
from bzrlib import trace
522
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
525
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
526
"""Convert a Unicode command line into a list of argv arguments.
528
It performs wildcard expansion to make wildcards act closer to how they
529
work in posix shells, versus how they work by default on Windows. Quoted
530
arguments are left untouched.
532
:param command_line: The unicode string to split into an arg list.
533
:param single_quotes_allowed: Whether single quotes are accepted as quoting
534
characters like double quotes. False by
536
:return: A list of unicode strings.
538
# First, spit the command line
539
s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
541
# Bug #587868 Now make sure that the length of s agrees with sys.argv
542
# we do this by simply counting the number of arguments in each. The counts should
543
# agree no matter what encoding sys.argv is in (AFAIK)
544
# len(arguments) < len(sys.argv) should be an impossibility since python gets
545
# args from the very same PEB as does GetCommandLineW
548
# Now shorten the command line we get from GetCommandLineW to match sys.argv
549
if len(arguments) < len(argv):
550
raise AssertionError("Split command line can't be shorter than argv")
551
arguments = arguments[len(arguments) - len(argv):]
553
# Carry on to process globs (metachars) in the command line
554
# expand globs if necessary
555
# TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
558
for is_quoted, arg in arguments:
559
if is_quoted or not glob.has_magic(arg):
562
args.extend(glob_one(arg))
566
if has_ctypes and winver != 'Windows 98':
567
def get_unicode_argv():
568
prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
569
GetCommandLineW = prototype(("GetCommandLineW",
570
ctypes.windll.kernel32))
571
command_line = GetCommandLineW()
572
if command_line is None:
573
raise ctypes.WinError()
574
# Skip the first argument, since we only care about parameters
575
argv = _command_line_to_argv(command_line, sys.argv)[1:]
578
get_unicode_argv = None
added
removed
bzrlib/win32utils.py
