25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
29
from ntpath import (abspath as _nt_abspath,
31
normpath as _nt_normpath,
32
realpath as _nt_realpath,
33
splitdrive as _nt_splitdrive,
33
# We need to import both shutil and rmtree as we export the later on posix
34
# and need the former on windows
36
from shutil import rmtree
39
# We need to import both tempfile and mkdtemp as we export the later on posix
40
# and need the former on windows
43
from tempfile import (
42
from tempfile import mkdtemp
48
45
from bzrlib import (
52
from bzrlib.i18n import gettext
56
55
from bzrlib.symbol_versioning import (
57
57
deprecated_function,
60
warn as warn_deprecated,
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
if sys.version_info < (2, 5):
64
import md5 as _mod_md5
66
import sha as _mod_sha
76
from bzrlib import symbol_versioning
70
from bzrlib import symbol_versioning, _fs_enc
79
73
# Cross platform wall-clock time functionality with decent resolution.
110
104
mod = os.lstat(filename).st_mode
111
105
if not stat.S_ISLNK(mod):
112
106
mod = mod & 0777555
113
os.chmod(filename, mod)
107
chmod_if_possible(filename, mod)
116
110
def make_writable(filename):
117
111
mod = os.lstat(filename).st_mode
118
112
if not stat.S_ISLNK(mod):
120
os.chmod(filename, mod)
114
chmod_if_possible(filename, mod)
117
def chmod_if_possible(filename, mode):
118
# Set file mode if that can be safely done.
119
# Sometimes even on unix the filesystem won't allow it - see
120
# https://bugs.launchpad.net/bzr/+bug/606537
122
# It is probably faster to just do the chmod, rather than
123
# doing a stat, and then trying to compare
124
os.chmod(filename, mode)
125
except (IOError, OSError),e:
126
# Permission/access denied seems to commonly happen on smbfs; there's
127
# probably no point warning about it.
128
# <https://bugs.launchpad.net/bzr/+bug/606537>
129
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
130
trace.mutter("ignore error on chmod of %r: %r" % (
123
136
def minimum_path_selection(paths):
275
288
rename_func(tmp_name, new)
276
289
if failure_exc is not None:
277
raise failure_exc[0], failure_exc[1], failure_exc[2]
291
raise failure_exc[0], failure_exc[1], failure_exc[2]
280
296
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
297
# choke on a Unicode string containing a relative path if
282
298
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
300
def _posix_abspath(path):
286
301
# jam 20060426 rather than encoding to fsencoding
287
302
# copy posixpath.abspath, but use os.getcwdu instead
288
303
if not posixpath.isabs(path):
289
304
path = posixpath.join(getcwd(), path)
290
return posixpath.normpath(path)
305
return _posix_normpath(path)
293
308
def _posix_realpath(path):
294
309
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
def _posix_normpath(path):
313
path = posixpath.normpath(path)
314
# Bug 861008: posixpath.normpath() returns a path normalized according to
315
# the POSIX standard, which stipulates (for compatibility reasons) that two
316
# leading slashes must not be simplified to one, and only if there are 3 or
317
# more should they be simplified as one. So we treat the leading 2 slashes
318
# as a special case here by simply removing the first slash, as we consider
319
# that breaking POSIX compatibility for this obscure feature is acceptable.
320
# This is not a paranoid precaution, as we notably get paths like this when
321
# the repo is hosted at the root of the filesystem, i.e. in "/".
322
if path.startswith('//'):
327
def _posix_path_from_environ(key):
328
"""Get unicode path from `key` in environment or None if not present
330
Note that posix systems use arbitrary byte strings for filesystem objects,
331
so a path that raises BadFilenameEncoding here may still be accessible.
333
val = os.environ.get(key, None)
337
return val.decode(_fs_enc)
338
except UnicodeDecodeError:
339
# GZ 2011-12-12:Ideally want to include `key` in the exception message
340
raise errors.BadFilenameEncoding(val, _fs_enc)
343
def _posix_getuser_unicode():
344
"""Get username from environment or password database as unicode"""
345
name = getpass.getuser()
346
user_encoding = get_user_encoding()
348
return name.decode(user_encoding)
349
except UnicodeDecodeError:
350
raise errors.BzrError("Encoding of username %r is unsupported by %s "
351
"application locale." % (name, user_encoding))
297
354
def _win32_fixdrive(path):
298
355
"""Force drive letters to be consistent.
303
360
running python.exe under cmd.exe return capital C:\\
304
361
running win32 python inside a cygwin shell returns lowercase c:\\
306
drive, path = _nt_splitdrive(path)
363
drive, path = ntpath.splitdrive(path)
307
364
return drive.upper() + path
310
367
def _win32_abspath(path):
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
368
# Real ntpath.abspath doesn't have a problem with a unicode cwd
369
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
315
372
def _win98_abspath(path):
326
383
# /path => C:/path
327
384
path = unicode(path)
328
385
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
386
drive = ntpath.splitdrive(path)[0]
330
387
if drive == '' and path[:2] not in('//','\\\\'):
331
388
cwd = os.getcwdu()
332
389
# we cannot simply os.path.join cwd and path
333
390
# because os.path.join('C:','/path') produce '/path'
334
391
# and this is incorrect
335
392
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
393
cwd = ntpath.splitdrive(cwd)[0]
338
395
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
396
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
399
def _win32_realpath(path):
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
400
# Real ntpath.realpath doesn't have a problem with a unicode cwd
401
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
404
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
405
return ntpath.join(*args).replace('\\', '/')
351
408
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
409
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
412
def _win32_getcwd():
477
536
input_encoding = getattr(sys.stdin, 'encoding', None)
478
537
if not input_encoding:
479
538
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
540
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
543
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
545
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
549
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
550
if output_encoding == 'cp0':
488
551
# invalid encoding (cp0 means 'no codepage' on Windows)
489
552
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
554
mutter('cp0 is invalid encoding.'
491
555
' encoding stdout as osutils.get_user_encoding() %r',
1250
1312
# but for now, we haven't optimized...
1251
1313
return [canonical_relpath(base, p) for p in paths]
1316
def decode_filename(filename):
1317
"""Decode the filename using the filesystem encoding
1319
If it is unicode, it is returned.
1320
Otherwise it is decoded from the the filesystem's encoding. If decoding
1321
fails, a errors.BadFilenameEncoding exception is raised.
1323
if type(filename) is unicode:
1326
return filename.decode(_fs_enc)
1327
except UnicodeDecodeError:
1328
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1331
def safe_unicode(unicode_or_utf8_string):
1254
1332
"""Coerce unicode_or_utf8_string into unicode.
1427
1511
- if BZR_COLUMNS is set, returns its value
1428
1512
- if there is no controlling terminal, returns None
1513
- query the OS, if the queried size has changed since the last query,
1429
1515
- if COLUMNS is set, returns its value,
1516
- if the OS has a value (even though it's never changed), return its value.
1431
1518
From there, we need to query the OS to get the size of the controlling
1521
On Unices we query the OS by:
1435
1522
- get termios.TIOCGWINSZ
1436
1523
- if an error occurs or a negative value is obtained, returns None
1525
On Windows we query the OS by:
1440
1526
- win32utils.get_console_size() decides,
1441
1527
- returns None on error (provided default value)
1529
# Note to implementors: if changing the rules for determining the width,
1530
# make sure you've considered the behaviour in these cases:
1531
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1532
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1534
# - (add more interesting cases here, if you find any)
1535
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1536
# but we don't want to register a signal handler because it is impossible
1537
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1538
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1539
# time so we can notice if the reported size has changed, which should have
1444
1542
# If BZR_COLUMNS is set, take it, user is always right
1543
# Except if they specified 0 in which case, impose no limit here
1446
return int(os.environ['BZR_COLUMNS'])
1545
width = int(os.environ['BZR_COLUMNS'])
1447
1546
except (KeyError, ValueError):
1548
if width is not None:
1450
1554
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1555
if isatty is None or not isatty():
1452
1556
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1455
# If COLUMNS is set, take it, the terminal knows better (even inside a
1456
# given terminal, the application can decide to set COLUMNS to a lower
1457
# value (splitted screen) or a bigger value (scroll bars))
1560
width, height = os_size = _terminal_size(None, None)
1561
global _first_terminal_size, _terminal_size_state
1562
if _terminal_size_state == 'no_data':
1563
_first_terminal_size = os_size
1564
_terminal_size_state = 'unchanged'
1565
elif (_terminal_size_state == 'unchanged' and
1566
_first_terminal_size != os_size):
1567
_terminal_size_state = 'changed'
1569
# If the OS claims to know how wide the terminal is, and this value has
1570
# ever changed, use that.
1571
if _terminal_size_state == 'changed':
1572
if width is not None and width > 0:
1575
# If COLUMNS is set, use it.
1459
1577
return int(os.environ['COLUMNS'])
1460
1578
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1581
# Finally, use an unchanged size from the OS, if we have one.
1582
if _terminal_size_state == 'unchanged':
1583
if width is not None and width > 0:
1586
# The width could not be determined.
1471
1590
def _win32_terminal_size(width, height):
1498
1617
_terminal_size = _ioctl_terminal_size
1501
def _terminal_size_changed(signum, frame):
1502
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
width, height = _terminal_size(None, None)
1504
if width is not None:
1505
os.environ['COLUMNS'] = str(width)
1508
_registered_sigwinch = False
1509
def watch_sigwinch():
1510
"""Register for SIGWINCH, once and only once.
1512
Do nothing if the signal module is not available.
1514
global _registered_sigwinch
1515
if not _registered_sigwinch:
1518
if getattr(signal, "SIGWINCH", None) is not None:
1519
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
# python doesn't provide signal support, nothing we can do about it
1523
_registered_sigwinch = True
1526
1620
def supports_executable():
1527
1621
return sys.platform != "win32"
1886
1981
_cached_user_encoding = None
1889
def get_user_encoding(use_cache=True):
1984
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
1985
"""Find out what the preferred user encoding is.
1892
1987
This is generally the encoding that is used for command line parameters
1893
1988
and file contents. This may be different from the terminal encoding
1894
1989
or the filesystem encoding.
1896
:param use_cache: Enable cache for detected encoding.
1897
(This parameter is turned on by default,
1898
and required only for selftesting)
1900
1991
:return: A string defining the preferred user encoding
1902
1993
global _cached_user_encoding
1903
if _cached_user_encoding is not None and use_cache:
1994
if deprecated_passed(use_cache):
1995
warn_deprecated("use_cache should only have been used for tests",
1996
DeprecationWarning, stacklevel=2)
1997
if _cached_user_encoding is not None:
1904
1998
return _cached_user_encoding
1906
if sys.platform == 'darwin':
1907
# python locale.getpreferredencoding() always return
1908
# 'mac-roman' on darwin. That's a lie.
1909
sys.platform = 'posix'
1911
if os.environ.get('LANG', None) is None:
1912
# If LANG is not set, we end up with 'ascii', which is bad
1913
# ('mac-roman' is more than ascii), so we set a default which
1914
# will give us UTF-8 (which appears to work in all cases on
1915
# OSX). Users are still free to override LANG of course, as
1916
# long as it give us something meaningful. This work-around
1917
# *may* not be needed with python 3k and/or OSX 10.5, but will
1918
# work with them too -- vila 20080908
1919
os.environ['LANG'] = 'en_US.UTF-8'
1922
sys.platform = 'darwin'
2000
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2001
# Use the existing locale settings and call nl_langinfo directly
2002
# rather than going through getpreferredencoding. This avoids
2003
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2004
# possibility of the setlocale call throwing an error.
2005
user_encoding = locale.nl_langinfo(locale.CODESET)
2007
# GZ 2011-12-19: On windows could call GetACP directly instead.
2008
user_encoding = locale.getpreferredencoding(False)
1927
user_encoding = locale.getpreferredencoding()
1928
except locale.Error, e:
1929
sys.stderr.write('bzr: warning: %s\n'
1930
' Could not determine what text encoding to use.\n'
1931
' This error usually means your Python interpreter\n'
1932
' doesn\'t support the locale set by $LANG (%s)\n'
1933
" Continuing with ascii encoding.\n"
1934
% (e, os.environ.get('LANG')))
1935
user_encoding = 'ascii'
1937
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
# treat that as ASCII, and not support printing unicode characters to the
1941
# For python scripts run under vim, we get '', so also treat that as ASCII
1942
if user_encoding in (None, 'cp0', ''):
1943
user_encoding = 'ascii'
1947
codecs.lookup(user_encoding)
2011
user_encoding = codecs.lookup(user_encoding).name
2013
if user_encoding not in ("", "cp0"):
1949
2014
sys.stderr.write('bzr: warning:'
1950
2015
' unknown encoding %s.'
1951
2016
' Continuing with ascii encoding.\n'
1952
2017
% user_encoding
1954
user_encoding = 'ascii'
1957
_cached_user_encoding = user_encoding
2019
user_encoding = 'ascii'
2021
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2022
if user_encoding == 'ascii':
2023
if sys.platform == 'darwin':
2024
# OSX is special-cased in Python to have a UTF-8 filesystem
2025
# encoding and previously had LANG set here if not present.
2026
user_encoding = 'utf-8'
2027
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2028
# for some other posix platforms as well.
2030
_cached_user_encoding = user_encoding
1959
2031
return user_encoding
2034
def get_diff_header_encoding():
2035
return get_terminal_encoding()
1962
2038
def get_host_name():
1963
2039
"""Return the current unicode host name.
2051
2135
report_activity(sent, 'write')
2138
def connect_socket(address):
2139
# Slight variation of the socket.create_connection() function (provided by
2140
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2141
# provide it for previous python versions. Also, we don't use the timeout
2142
# parameter (provided by the python implementation) so we don't implement
2144
err = socket.error('getaddrinfo returns an empty list')
2145
host, port = address
2146
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2147
af, socktype, proto, canonname, sa = res
2150
sock = socket.socket(af, socktype, proto)
2154
except socket.error, err:
2155
# 'err' is now the most recent error
2156
if sock is not None:
2054
2161
def dereference_path(path):
2055
2162
"""Determine the real path to a file.
2114
2223
return file_kind_from_stat_mode(mode)
2115
2224
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2118
def file_kind(f, _lstat=os.lstat):
2226
def file_stat(f, _lstat=os.lstat):
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
2230
except OSError, e:
2122
2231
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2232
raise errors.NoSuchFile(f)
2235
def file_kind(f, _lstat=os.lstat):
2236
stat_value = file_stat(f, _lstat)
2237
return file_kind_from_stat_mode(stat_value.st_mode)
2127
2239
def until_no_eintr(f, *a, **kw):
2128
2240
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2242
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2243
if EINTR does occur. This is typically only true for low-level operations
2132
2244
like os.read. If in any doubt, don't use this.
2187
2300
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2191
if sys.platform == 'linux2':
2303
if sys.platform.startswith('linux'):
2192
2304
def _local_concurrency():
2194
prefix = 'processor'
2195
for line in file('/proc/cpuinfo', 'rb'):
2196
if line.startswith(prefix):
2197
concurrency = int(line[line.find(':')+1:]) + 1
2306
return os.sysconf('SC_NPROCESSORS_ONLN')
2307
except (ValueError, OSError, AttributeError):
2199
2309
elif sys.platform == 'darwin':
2200
2310
def _local_concurrency():
2201
2311
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2312
stdout=subprocess.PIPE).communicate()[0]
2203
elif sys.platform[0:7] == 'freebsd':
2313
elif "bsd" in sys.platform:
2204
2314
def _local_concurrency():
2205
2315
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2316
stdout=subprocess.PIPE).communicate()[0]
2234
2344
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2345
if concurrency is None:
2237
concurrency = _local_concurrency()
2238
except (OSError, IOError):
2347
import multiprocessing
2348
concurrency = multiprocessing.cpu_count()
2349
except (ImportError, NotImplementedError):
2350
# multiprocessing is only available on Python >= 2.6
2351
# and multiprocessing.cpu_count() isn't implemented on all
2354
concurrency = _local_concurrency()
2355
except (OSError, IOError):
2241
2358
concurrency = int(concurrency)
2242
2359
except (TypeError, ValueError):
2302
2419
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2421
open_file = open
2424
def available_backup_name(base, exists):
2425
"""Find a non-existing backup file name.
2427
This will *not* create anything, this only return a 'free' entry. This
2428
should be used for checking names in a directory below a locked
2429
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2430
Leap) and generally discouraged.
2432
:param base: The base name.
2434
:param exists: A callable returning True if the path parameter exists.
2437
name = "%s.~%d~" % (base, counter)
2440
name = "%s.~%d~" % (base, counter)
2444
def set_fd_cloexec(fd):
2445
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2446
support for this is not available.
2450
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2451
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2452
except (ImportError, AttributeError):
2453
# Either the fcntl module or specific constants are not present
2457
def find_executable_on_path(name):
2458
"""Finds an executable on the PATH.
2460
On Windows, this will try to append each extension in the PATHEXT
2461
environment variable to the name, if it cannot be found with the name
2464
:param name: The base name of the executable.
2465
:return: The path to the executable found or None.
2467
path = os.environ.get('PATH')
2470
path = path.split(os.pathsep)
2471
if sys.platform == 'win32':
2472
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2473
exts = [ext.lower() for ext in exts]
2474
base, ext = os.path.splitext(name)
2476
if ext.lower() not in exts:
2484
f = os.path.join(d, name) + ext
2485
if os.access(f, os.X_OK):
2490
def _posix_is_local_pid_dead(pid):
2491
"""True if pid doesn't correspond to live process on this machine"""
2493
# Special meaning of unix kill: just check if it's there.
2496
if e.errno == errno.ESRCH:
2497
# On this machine, and really not found: as sure as we can be
2500
elif e.errno == errno.EPERM:
2501
# exists, though not ours
2504
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2505
# Don't really know.
2508
# Exists and our process: not dead.
2511
if sys.platform == "win32":
2512
is_local_pid_dead = win32utils.is_local_pid_dead
2514
is_local_pid_dead = _posix_is_local_pid_dead
2517
def fdatasync(fileno):
2518
"""Flush file contents to disk if possible.
2520
:param fileno: Integer OS file handle.
2521
:raises TransportNotPossible: If flushing to disk is not possible.
2523
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2528
def ensure_empty_directory_exists(path, exception_class):
2529
"""Make sure a local directory exists and is empty.
2531
If it does not exist, it is created. If it exists and is not empty, an
2532
instance of exception_class is raised.
2537
if e.errno != errno.EEXIST:
2539
if os.listdir(path) != []:
2540
raise exception_class(path)
2543
def is_environment_error(evalue):
2544
"""True if exception instance is due to a process environment issue
2546
This includes OSError and IOError, but also other errors that come from
2547
the operating system or core libraries but are not subclasses of those.
2549
if isinstance(evalue, (EnvironmentError, select.error)):
2551
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
