27
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
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,
35
# We need to import both shutil and rmtree as we export the later on posix
36
# and need the former on windows
38
from shutil import rmtree
41
# We need to import both tempfile and mkdtemp as we export the later on posix
42
# and need the former on windows
44
from tempfile import mkdtemp
43
from tempfile import (
47
48
from bzrlib import (
54
from bzrlib.i18n import gettext
57
56
from bzrlib.symbol_versioning import (
59
57
deprecated_function,
62
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
72
from bzrlib import symbol_versioning, _fs_enc
76
from bzrlib import symbol_versioning
75
79
# Cross platform wall-clock time functionality with decent resolution.
106
110
mod = os.lstat(filename).st_mode
107
111
if not stat.S_ISLNK(mod):
108
112
mod = mod & 0777555
109
chmod_if_possible(filename, mod)
113
os.chmod(filename, mod)
112
116
def make_writable(filename):
113
117
mod = os.lstat(filename).st_mode
114
118
if not stat.S_ISLNK(mod):
116
chmod_if_possible(filename, mod)
119
def chmod_if_possible(filename, mode):
120
# Set file mode if that can be safely done.
121
# Sometimes even on unix the filesystem won't allow it - see
122
# https://bugs.launchpad.net/bzr/+bug/606537
124
# It is probably faster to just do the chmod, rather than
125
# doing a stat, and then trying to compare
126
os.chmod(filename, mode)
127
except (IOError, OSError),e:
128
# Permission/access denied seems to commonly happen on smbfs; there's
129
# probably no point warning about it.
130
# <https://bugs.launchpad.net/bzr/+bug/606537>
131
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
132
trace.mutter("ignore error on chmod of %r: %r" % (
120
os.chmod(filename, mod)
138
123
def minimum_path_selection(paths):
290
275
rename_func(tmp_name, new)
291
276
if failure_exc is not None:
293
raise failure_exc[0], failure_exc[1], failure_exc[2]
277
raise failure_exc[0], failure_exc[1], failure_exc[2]
298
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
281
# choke on a Unicode string containing a relative path if
300
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
285
def _posix_abspath(path):
303
286
# jam 20060426 rather than encoding to fsencoding
304
287
# copy posixpath.abspath, but use os.getcwdu instead
305
288
if not posixpath.isabs(path):
306
289
path = posixpath.join(getcwd(), path)
307
return _posix_normpath(path)
290
return posixpath.normpath(path)
310
293
def _posix_realpath(path):
311
294
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
314
def _posix_normpath(path):
315
path = posixpath.normpath(path)
316
# Bug 861008: posixpath.normpath() returns a path normalized according to
317
# the POSIX standard, which stipulates (for compatibility reasons) that two
318
# leading slashes must not be simplified to one, and only if there are 3 or
319
# more should they be simplified as one. So we treat the leading 2 slashes
320
# as a special case here by simply removing the first slash, as we consider
321
# that breaking POSIX compatibility for this obscure feature is acceptable.
322
# This is not a paranoid precaution, as we notably get paths like this when
323
# the repo is hosted at the root of the filesystem, i.e. in "/".
324
if path.startswith('//'):
329
def _posix_path_from_environ(key):
330
"""Get unicode path from `key` in environment or None if not present
332
Note that posix systems use arbitrary byte strings for filesystem objects,
333
so a path that raises BadFilenameEncoding here may still be accessible.
335
val = os.environ.get(key, None)
339
return val.decode(_fs_enc)
340
except UnicodeDecodeError:
341
# GZ 2011-12-12:Ideally want to include `key` in the exception message
342
raise errors.BadFilenameEncoding(val, _fs_enc)
345
def _posix_getuser_unicode():
346
"""Get username from environment or password database as unicode"""
347
name = getpass.getuser()
348
user_encoding = get_user_encoding()
350
return name.decode(user_encoding)
351
except UnicodeDecodeError:
352
raise errors.BzrError("Encoding of username %r is unsupported by %s "
353
"application locale." % (name, user_encoding))
356
297
def _win32_fixdrive(path):
357
298
"""Force drive letters to be consistent.
362
303
running python.exe under cmd.exe return capital C:\\
363
304
running win32 python inside a cygwin shell returns lowercase c:\\
365
drive, path = ntpath.splitdrive(path)
306
drive, path = _nt_splitdrive(path)
366
307
return drive.upper() + path
369
310
def _win32_abspath(path):
370
# Real ntpath.abspath doesn't have a problem with a unicode cwd
371
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
374
315
def _win98_abspath(path):
385
326
# /path => C:/path
386
327
path = unicode(path)
387
328
# check for absolute path
388
drive = ntpath.splitdrive(path)[0]
329
drive = _nt_splitdrive(path)[0]
389
330
if drive == '' and path[:2] not in('//','\\\\'):
390
331
cwd = os.getcwdu()
391
332
# we cannot simply os.path.join cwd and path
392
333
# because os.path.join('C:','/path') produce '/path'
393
334
# and this is incorrect
394
335
if path[:1] in ('/','\\'):
395
cwd = ntpath.splitdrive(cwd)[0]
336
cwd = _nt_splitdrive(cwd)[0]
397
338
path = cwd + '\\' + path
398
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
401
342
def _win32_realpath(path):
402
# Real ntpath.realpath doesn't have a problem with a unicode cwd
403
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
406
347
def _win32_pathjoin(*args):
407
return ntpath.join(*args).replace('\\', '/')
348
return _nt_join(*args).replace('\\', '/')
410
351
def _win32_normpath(path):
411
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
414
355
def _win32_getcwd():
538
477
input_encoding = getattr(sys.stdin, 'encoding', None)
539
478
if not input_encoding:
540
479
output_encoding = get_user_encoding()
542
mutter('encoding stdout as osutils.get_user_encoding() %r',
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
545
483
output_encoding = input_encoding
547
mutter('encoding stdout as sys.stdin encoding %r',
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
551
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
552
487
if output_encoding == 'cp0':
553
488
# invalid encoding (cp0 means 'no codepage' on Windows)
554
489
output_encoding = get_user_encoding()
556
mutter('cp0 is invalid encoding.'
490
mutter('cp0 is invalid encoding.'
557
491
' encoding stdout as osutils.get_user_encoding() %r',
948
882
"""Return size of given open file."""
949
return os.fstat(f.fileno())[stat.ST_SIZE]
952
# Alias os.urandom to support platforms (which?) without /dev/urandom and
953
# override if it doesn't work. Avoid checking on windows where there is
954
# significant initialisation cost that can be avoided for some bzr calls.
956
rand_bytes = os.urandom
958
if rand_bytes.__module__ != "nt":
883
return os.fstat(f.fileno())[ST_SIZE]
886
# Define rand_bytes based on platform.
888
# Python 2.4 and later have os.urandom,
889
# but it doesn't work on some arches
891
rand_bytes = os.urandom
892
except (NotImplementedError, AttributeError):
893
# If python doesn't have os.urandom, or it doesn't work,
894
# then try to first pull random data from /dev/urandom
961
except NotImplementedError:
896
rand_bytes = file('/dev/urandom', 'rb').read
897
# Otherwise, use this hack as a last resort
898
except (IOError, OSError):
962
899
# not well seeded, but better than nothing
963
900
def rand_bytes(n):
1311
1250
# but for now, we haven't optimized...
1312
1251
return [canonical_relpath(base, p) for p in paths]
1315
def decode_filename(filename):
1316
"""Decode the filename using the filesystem encoding
1318
If it is unicode, it is returned.
1319
Otherwise it is decoded from the the filesystem's encoding. If decoding
1320
fails, a errors.BadFilenameEncoding exception is raised.
1322
if type(filename) is unicode:
1325
return filename.decode(_fs_enc)
1326
except UnicodeDecodeError:
1327
raise errors.BadFilenameEncoding(filename, _fs_enc)
1330
1253
def safe_unicode(unicode_or_utf8_string):
1331
1254
"""Coerce unicode_or_utf8_string into unicode.
1510
1427
- if BZR_COLUMNS is set, returns its value
1511
1428
- if there is no controlling terminal, returns None
1512
- query the OS, if the queried size has changed since the last query,
1514
1429
- if COLUMNS is set, returns its value,
1515
- if the OS has a value (even though it's never changed), return its value.
1517
1431
From there, we need to query the OS to get the size of the controlling
1520
On Unices we query the OS by:
1521
1435
- get termios.TIOCGWINSZ
1522
1436
- if an error occurs or a negative value is obtained, returns None
1524
On Windows we query the OS by:
1525
1440
- win32utils.get_console_size() decides,
1526
1441
- returns None on error (provided default value)
1528
# Note to implementors: if changing the rules for determining the width,
1529
# make sure you've considered the behaviour in these cases:
1530
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1531
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1533
# - (add more interesting cases here, if you find any)
1534
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1535
# but we don't want to register a signal handler because it is impossible
1536
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1537
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1538
# time so we can notice if the reported size has changed, which should have
1541
1444
# If BZR_COLUMNS is set, take it, user is always right
1542
# Except if they specified 0 in which case, impose no limit here
1544
width = int(os.environ['BZR_COLUMNS'])
1446
return int(os.environ['BZR_COLUMNS'])
1545
1447
except (KeyError, ValueError):
1547
if width is not None:
1553
1450
isatty = getattr(sys.stdout, 'isatty', None)
1554
if isatty is None or not isatty():
1451
if isatty is None or not isatty():
1555
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1559
width, height = os_size = _terminal_size(None, None)
1560
global _first_terminal_size, _terminal_size_state
1561
if _terminal_size_state == 'no_data':
1562
_first_terminal_size = os_size
1563
_terminal_size_state = 'unchanged'
1564
elif (_terminal_size_state == 'unchanged' and
1565
_first_terminal_size != os_size):
1566
_terminal_size_state = 'changed'
1568
# If the OS claims to know how wide the terminal is, and this value has
1569
# ever changed, use that.
1570
if _terminal_size_state == 'changed':
1571
if width is not None and width > 0:
1574
# If COLUMNS is set, use it.
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))
1576
1459
return int(os.environ['COLUMNS'])
1577
1460
except (KeyError, ValueError):
1580
# Finally, use an unchanged size from the OS, if we have one.
1581
if _terminal_size_state == 'unchanged':
1582
if width is not None and width > 0:
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1585
# The width could not be determined.
1589
1471
def _win32_terminal_size(width, height):
1616
1498
_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
1619
1526
def supports_executable():
1620
1527
return sys.platform != "win32"
1980
1886
_cached_user_encoding = None
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1889
def get_user_encoding(use_cache=True):
1984
1890
"""Find out what the preferred user encoding is.
1986
1892
This is generally the encoding that is used for command line parameters
1987
1893
and file contents. This may be different from the terminal encoding
1988
1894
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)
1990
1900
:return: A string defining the preferred user encoding
1992
1902
global _cached_user_encoding
1993
if deprecated_passed(use_cache):
1994
warn_deprecated("use_cache should only have been used for tests",
1995
DeprecationWarning, stacklevel=2)
1996
if _cached_user_encoding is not None:
1903
if _cached_user_encoding is not None and use_cache:
1997
1904
return _cached_user_encoding
1999
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2000
# Use the existing locale settings and call nl_langinfo directly
2001
# rather than going through getpreferredencoding. This avoids
2002
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2003
# possibility of the setlocale call throwing an error.
2004
user_encoding = locale.nl_langinfo(locale.CODESET)
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'
2006
# GZ 2011-12-19: On windows could call GetACP directly instead.
2007
user_encoding = locale.getpreferredencoding(False)
2010
user_encoding = codecs.lookup(user_encoding).name
2012
if user_encoding not in ("", "cp0"):
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)
2013
1949
sys.stderr.write('bzr: warning:'
2014
1950
' unknown encoding %s.'
2015
1951
' Continuing with ascii encoding.\n'
2016
1952
% user_encoding
2018
user_encoding = 'ascii'
2020
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2021
if user_encoding == 'ascii':
2022
if sys.platform == 'darwin':
2023
# OSX is special-cased in Python to have a UTF-8 filesystem
2024
# encoding and previously had LANG set here if not present.
2025
user_encoding = 'utf-8'
2026
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2027
# for some other posix platforms as well.
2029
_cached_user_encoding = user_encoding
1954
user_encoding = 'ascii'
1957
_cached_user_encoding = user_encoding
2030
1959
return user_encoding
2033
def get_diff_header_encoding():
2034
return get_terminal_encoding()
2037
1962
def get_host_name():
2038
1963
"""Return the current unicode host name.
2133
2051
report_activity(sent, 'write')
2136
def connect_socket(address):
2137
# Slight variation of the socket.create_connection() function (provided by
2138
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2139
# provide it for previous python versions. Also, we don't use the timeout
2140
# parameter (provided by the python implementation) so we don't implement
2142
err = socket.error('getaddrinfo returns an empty list')
2143
host, port = address
2144
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2145
af, socktype, proto, canonname, sa = res
2148
sock = socket.socket(af, socktype, proto)
2152
except socket.error, err:
2153
# 'err' is now the most recent error
2154
if sock is not None:
2159
2054
def dereference_path(path):
2160
2055
"""Determine the real path to a file.
2221
2114
return file_kind_from_stat_mode(mode)
2222
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2224
def file_stat(f, _lstat=os.lstat):
2118
def file_kind(f, _lstat=os.lstat):
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2228
2121
except OSError, e:
2229
2122
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2230
2123
raise errors.NoSuchFile(f)
2233
def file_kind(f, _lstat=os.lstat):
2234
stat_value = file_stat(f, _lstat)
2235
return file_kind_from_stat_mode(stat_value.st_mode)
2237
2127
def until_no_eintr(f, *a, **kw):
2238
2128
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2240
2130
WARNING: you must be certain that it is safe to retry the call repeatedly
2241
2131
if EINTR does occur. This is typically only true for low-level operations
2242
2132
like os.read. If in any doubt, don't use this.
2298
2187
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2301
if sys.platform.startswith('linux'):
2191
if sys.platform == 'linux2':
2302
2192
def _local_concurrency():
2304
return os.sysconf('SC_NPROCESSORS_ONLN')
2305
except (ValueError, OSError, AttributeError):
2194
prefix = 'processor'
2195
for line in file('/proc/cpuinfo', 'rb'):
2196
if line.startswith(prefix):
2197
concurrency = int(line[line.find(':')+1:]) + 1
2307
2199
elif sys.platform == 'darwin':
2308
2200
def _local_concurrency():
2309
2201
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2310
2202
stdout=subprocess.PIPE).communicate()[0]
2311
elif "bsd" in sys.platform:
2203
elif sys.platform[0:7] == 'freebsd':
2312
2204
def _local_concurrency():
2313
2205
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2314
2206
stdout=subprocess.PIPE).communicate()[0]
2342
2234
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2343
2235
if concurrency is None:
2345
import multiprocessing
2346
concurrency = multiprocessing.cpu_count()
2347
except (ImportError, NotImplementedError):
2348
# multiprocessing is only available on Python >= 2.6
2349
# and multiprocessing.cpu_count() isn't implemented on all
2352
concurrency = _local_concurrency()
2353
except (OSError, IOError):
2237
concurrency = _local_concurrency()
2238
except (OSError, IOError):
2356
2241
concurrency = int(concurrency)
2357
2242
except (TypeError, ValueError):
2417
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
2419
2304
open_file = open
2422
def available_backup_name(base, exists):
2423
"""Find a non-existing backup file name.
2425
This will *not* create anything, this only return a 'free' entry. This
2426
should be used for checking names in a directory below a locked
2427
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2428
Leap) and generally discouraged.
2430
:param base: The base name.
2432
:param exists: A callable returning True if the path parameter exists.
2435
name = "%s.~%d~" % (base, counter)
2438
name = "%s.~%d~" % (base, counter)
2442
def set_fd_cloexec(fd):
2443
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2444
support for this is not available.
2448
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2449
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2450
except (ImportError, AttributeError):
2451
# Either the fcntl module or specific constants are not present
2455
def find_executable_on_path(name):
2456
"""Finds an executable on the PATH.
2458
On Windows, this will try to append each extension in the PATHEXT
2459
environment variable to the name, if it cannot be found with the name
2462
:param name: The base name of the executable.
2463
:return: The path to the executable found or None.
2465
path = os.environ.get('PATH')
2468
path = path.split(os.pathsep)
2469
if sys.platform == 'win32':
2470
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2471
exts = [ext.lower() for ext in exts]
2472
base, ext = os.path.splitext(name)
2474
if ext.lower() not in exts:
2482
f = os.path.join(d, name) + ext
2483
if os.access(f, os.X_OK):
2488
def _posix_is_local_pid_dead(pid):
2489
"""True if pid doesn't correspond to live process on this machine"""
2491
# Special meaning of unix kill: just check if it's there.
2494
if e.errno == errno.ESRCH:
2495
# On this machine, and really not found: as sure as we can be
2498
elif e.errno == errno.EPERM:
2499
# exists, though not ours
2502
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2503
# Don't really know.
2506
# Exists and our process: not dead.
2509
if sys.platform == "win32":
2510
is_local_pid_dead = win32utils.is_local_pid_dead
2512
is_local_pid_dead = _posix_is_local_pid_dead
2515
def fdatasync(fileno):
2516
"""Flush file contents to disk if possible.
2518
:param fileno: Integer OS file handle.
2519
:raises TransportNotPossible: If flushing to disk is not possible.
2521
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2526
def ensure_empty_directory_exists(path, exception_class):
2527
"""Make sure a local directory exists and is empty.
2529
If it does not exist, it is created. If it exists and is not empty, an
2530
instance of exception_class is raised.
2535
if e.errno != errno.EEXIST:
2537
if os.listdir(path) != []:
2538
raise exception_class(path)
2541
def is_environment_error(evalue):
2542
"""True if exception instance is due to a process environment issue
2544
This includes OSError and IOError, but also other errors that come from
2545
the operating system or core libraries but are not subclasses of those.
2547
if isinstance(evalue, (EnvironmentError, select.error)):
2549
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):