14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
28
27
from datetime import datetime
30
from ntpath import (abspath as _nt_abspath,
32
normpath as _nt_normpath,
33
realpath as _nt_realpath,
34
splitdrive as _nt_splitdrive,
31
# We need to import both shutil and rmtree as we export the later on posix
32
# and need the former on windows
34
from shutil import rmtree
37
# We need to import both tempfile and mkdtemp as we export the later on posix
38
# and need the former on windows
42
from tempfile import (
40
from tempfile import mkdtemp
47
43
from bzrlib import (
51
from bzrlib.symbol_versioning import (
54
56
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
58
if sys.version_info < (2, 5):
69
71
from bzrlib import symbol_versioning
74
# Cross platform wall-clock time functionality with decent resolution.
75
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
76
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
77
# synchronized with ``time.time()``, this is only meant to be used to find
78
# delta times by subtracting from another call to this function.
79
timer_func = time.time
80
if sys.platform == 'win32':
81
timer_func = time.clock
72
83
# On win32, O_BINARY is used to indicate the file should
73
84
# be opened in binary mode, rather than text mode.
74
85
# On other platforms, O_BINARY doesn't exist, because
75
86
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
87
# OR with 0 on those platforms.
88
# O_NOINHERIT and O_TEXT exists only on win32 too.
77
89
O_BINARY = getattr(os, 'O_BINARY', 0)
90
O_TEXT = getattr(os, 'O_TEXT', 0)
91
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
94
def get_unicode_argv():
96
user_encoding = get_user_encoding()
97
return [a.decode(user_encoding) for a in sys.argv[1:]]
98
except UnicodeDecodeError:
99
raise errors.BzrError("Parameter %r encoding is unsupported by %s "
100
"application locale." % (a, user_encoding))
80
103
def make_readonly(filename):
279
321
# /path => C:/path
280
322
path = unicode(path)
281
323
# check for absolute path
282
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
283
325
if drive == '' and path[:2] not in('//','\\\\'):
284
326
cwd = os.getcwdu()
285
327
# we cannot simply os.path.join cwd and path
286
328
# because os.path.join('C:','/path') produce '/path'
287
329
# and this is incorrect
288
330
if path[:1] in ('/','\\'):
289
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
291
333
path = cwd + '\\' + path
292
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
295
337
def _win32_realpath(path):
296
# Real _nt_realpath doesn't have a problem with a unicode cwd
297
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
300
342
def _win32_pathjoin(*args):
301
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
304
346
def _win32_normpath(path):
305
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
308
350
def _win32_getcwd():
847
944
return pathjoin(*p)
947
def parent_directories(filename):
948
"""Return the list of parent directories, deepest first.
950
For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
parts = splitpath(dirname(filename))
955
parents.append(joinpath(parts))
960
_extension_load_failures = []
963
def failed_to_load_extension(exception):
964
"""Handle failing to load a binary extension.
966
This should be called from the ImportError block guarding the attempt to
967
import the native extension. If this function returns, the pure-Python
968
implementation should be loaded instead::
971
>>> import bzrlib._fictional_extension_pyx
972
>>> except ImportError, e:
973
>>> bzrlib.osutils.failed_to_load_extension(e)
974
>>> import bzrlib._fictional_extension_py
976
# NB: This docstring is just an example, not a doctest, because doctest
977
# currently can't cope with the use of lazy imports in this namespace --
980
# This currently doesn't report the failure at the time it occurs, because
981
# they tend to happen very early in startup when we can't check config
982
# files etc, and also we want to report all failures but not spam the user
984
exception_str = str(exception)
985
if exception_str not in _extension_load_failures:
986
trace.mutter("failed to load compiled extension: %s" % exception_str)
987
_extension_load_failures.append(exception_str)
990
def report_extension_load_failures():
991
if not _extension_load_failures:
993
from bzrlib.config import GlobalConfig
994
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
996
# the warnings framework should by default show this only once
997
from bzrlib.trace import warning
999
"bzr: warning: some compiled extensions could not be loaded; "
1000
"see <https://answers.launchpad.net/bzr/+faq/703>")
1001
# we no longer show the specific missing extensions here, because it makes
1002
# the message too long and scary - see
1003
# https://bugs.launchpad.net/bzr/+bug/430529
851
1007
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1008
except ImportError, e:
1009
failed_to_load_extension(e)
853
1010
from bzrlib._chunks_to_lines_py import chunks_to_lines
893
1050
shutil.copyfile(src, dest)
896
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
897
# Forgiveness than Permission (EAFP) because:
898
# - root can damage a solaris file system by using unlink,
899
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
900
# EACCES, OSX: EPERM) when invoked on a directory.
901
1053
def delete_any(path):
902
"""Delete a file or directory."""
1054
"""Delete a file, symlink or directory.
1056
Will delete even if readonly.
1059
_delete_file_or_dir(path)
1060
except (OSError, IOError), e:
1061
if e.errno in (errno.EPERM, errno.EACCES):
1062
# make writable and try again
1065
except (OSError, IOError):
1067
_delete_file_or_dir(path)
1072
def _delete_file_or_dir(path):
1073
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1074
# Forgiveness than Permission (EAFP) because:
1075
# - root can damage a solaris file system by using unlink,
1076
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1077
# EACCES, OSX: EPERM) when invoked on a directory.
903
1078
if isdir(path): # Takes care of symlinks
1047
1247
# but for now, we haven't optimized...
1048
1248
return [canonical_relpath(base, p) for p in paths]
1251
def decode_filename(filename):
1252
"""Decode the filename using the filesystem encoding
1254
If it is unicode, it is returned.
1255
Otherwise it is decoded from the the filesystem's encoding. If decoding
1256
fails, a errors.BadFilenameEncoding exception is raised.
1258
if type(filename) is unicode:
1261
return filename.decode(_fs_enc)
1262
except UnicodeDecodeError:
1263
raise errors.BadFilenameEncoding(filename, _fs_enc)
1050
1266
def safe_unicode(unicode_or_utf8_string):
1051
1267
"""Coerce unicode_or_utf8_string into unicode.
1053
1269
If it is unicode, it is returned.
1054
Otherwise it is decoded from utf-8. If a decoding error
1055
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
1056
as a BzrBadParameter exception.
1270
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1271
wrapped in a BzrBadParameterNotUnicode exception.
1058
1273
if isinstance(unicode_or_utf8_string, unicode):
1059
1274
return unicode_or_utf8_string
1172
1387
normalized_filename = _inaccessible_normalized_filename
1390
def set_signal_handler(signum, handler, restart_syscall=True):
1391
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1392
on platforms that support that.
1394
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1395
automatically restart (by calling `signal.siginterrupt(signum,
1396
False)`). May be ignored if the feature is not available on this
1397
platform or Python version.
1401
siginterrupt = signal.siginterrupt
1403
# This python implementation doesn't provide signal support, hence no
1406
except AttributeError:
1407
# siginterrupt doesn't exist on this platform, or for this version
1409
siginterrupt = lambda signum, flag: None
1411
def sig_handler(*args):
1412
# Python resets the siginterrupt flag when a signal is
1413
# received. <http://bugs.python.org/issue8354>
1414
# As a workaround for some cases, set it back the way we want it.
1415
siginterrupt(signum, False)
1416
# Now run the handler function passed to set_signal_handler.
1419
sig_handler = handler
1420
old_handler = signal.signal(signum, sig_handler)
1422
siginterrupt(signum, False)
1426
default_terminal_width = 80
1427
"""The default terminal width for ttys.
1429
This is defined so that higher levels can share a common fallback value when
1430
terminal_width() returns None.
1433
# Keep some state so that terminal_width can detect if _terminal_size has
1434
# returned a different size since the process started. See docstring and
1435
# comments of terminal_width for details.
1436
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1437
_terminal_size_state = 'no_data'
1438
_first_terminal_size = None
1175
1440
def terminal_width():
1176
"""Return estimated terminal width."""
1177
if sys.platform == 'win32':
1178
return win32utils.get_console_size()[0]
1441
"""Return terminal width.
1443
None is returned if the width can't established precisely.
1446
- if BZR_COLUMNS is set, returns its value
1447
- if there is no controlling terminal, returns None
1448
- query the OS, if the queried size has changed since the last query,
1450
- if COLUMNS is set, returns its value,
1451
- if the OS has a value (even though it's never changed), return its value.
1453
From there, we need to query the OS to get the size of the controlling
1456
On Unices we query the OS by:
1457
- get termios.TIOCGWINSZ
1458
- if an error occurs or a negative value is obtained, returns None
1460
On Windows we query the OS by:
1461
- win32utils.get_console_size() decides,
1462
- returns None on error (provided default value)
1464
# Note to implementors: if changing the rules for determining the width,
1465
# make sure you've considered the behaviour in these cases:
1466
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1467
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1469
# - (add more interesting cases here, if you find any)
1470
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1471
# but we don't want to register a signal handler because it is impossible
1472
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1473
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1474
# time so we can notice if the reported size has changed, which should have
1477
# If BZR_COLUMNS is set, take it, user is always right
1478
# Except if they specified 0 in which case, impose no limit here
1480
width = int(os.environ['BZR_COLUMNS'])
1481
except (KeyError, ValueError):
1483
if width is not None:
1489
isatty = getattr(sys.stdout, 'isatty', None)
1490
if isatty is None or not isatty():
1491
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1495
width, height = os_size = _terminal_size(None, None)
1496
global _first_terminal_size, _terminal_size_state
1497
if _terminal_size_state == 'no_data':
1498
_first_terminal_size = os_size
1499
_terminal_size_state = 'unchanged'
1500
elif (_terminal_size_state == 'unchanged' and
1501
_first_terminal_size != os_size):
1502
_terminal_size_state = 'changed'
1504
# If the OS claims to know how wide the terminal is, and this value has
1505
# ever changed, use that.
1506
if _terminal_size_state == 'changed':
1507
if width is not None and width > 0:
1510
# If COLUMNS is set, use it.
1512
return int(os.environ['COLUMNS'])
1513
except (KeyError, ValueError):
1516
# Finally, use an unchanged size from the OS, if we have one.
1517
if _terminal_size_state == 'unchanged':
1518
if width is not None and width > 0:
1521
# The width could not be determined.
1525
def _win32_terminal_size(width, height):
1526
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1527
return width, height
1530
def _ioctl_terminal_size(width, height):
1181
1532
import struct, fcntl, termios
1182
1533
s = struct.pack('HHHH', 0, 0, 0, 0)
1183
1534
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1184
width = struct.unpack('HHHH', x)[1]
1535
height, width = struct.unpack('HHHH', x)[0:2]
1536
except (IOError, AttributeError):
1189
width = int(os.environ['COLUMNS'])
1538
return width, height
1540
_terminal_size = None
1541
"""Returns the terminal size as (width, height).
1543
:param width: Default value for width.
1544
:param height: Default value for height.
1546
This is defined specifically for each OS and query the size of the controlling
1547
terminal. If any error occurs, the provided default values should be returned.
1549
if sys.platform == 'win32':
1550
_terminal_size = _win32_terminal_size
1552
_terminal_size = _ioctl_terminal_size
1198
1555
def supports_executable():
1622
2009
return socket.gethostname().decode(get_user_encoding())
1625
def recv_all(socket, bytes):
2012
# We must not read/write any more than 64k at a time from/to a socket so we
2013
# don't risk "no buffer space available" errors on some platforms. Windows in
2014
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2016
MAX_SOCKET_CHUNK = 64 * 1024
2018
_end_of_stream_errors = [errno.ECONNRESET]
2019
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2020
_eno = getattr(errno, _eno, None)
2021
if _eno is not None:
2022
_end_of_stream_errors.append(_eno)
2026
def read_bytes_from_socket(sock, report_activity=None,
2027
max_read_size=MAX_SOCKET_CHUNK):
2028
"""Read up to max_read_size of bytes from sock and notify of progress.
2030
Translates "Connection reset by peer" into file-like EOF (return an
2031
empty string rather than raise an error), and repeats the recv if
2032
interrupted by a signal.
2036
bytes = sock.recv(max_read_size)
2037
except socket.error, e:
2039
if eno in _end_of_stream_errors:
2040
# The connection was closed by the other side. Callers expect
2041
# an empty string to signal end-of-stream.
2043
elif eno == errno.EINTR:
2044
# Retry the interrupted recv.
2048
if report_activity is not None:
2049
report_activity(len(bytes), 'read')
2053
def recv_all(socket, count):
1626
2054
"""Receive an exact number of bytes.
1628
2056
Regular Socket.recv() may return less than the requested number of bytes,
1629
dependning on what's in the OS buffer. MSG_WAITALL is not available
2057
depending on what's in the OS buffer. MSG_WAITALL is not available
1630
2058
on all platforms, but this should work everywhere. This will return
1631
2059
less than the requested amount if the remote end closes.
1633
2061
This isn't optimized and is intended mostly for use in testing.
1636
while len(b) < bytes:
1637
new = until_no_eintr(socket.recv, bytes - len(b))
2064
while len(b) < count:
2065
new = read_bytes_from_socket(socket, None, count - len(b))
1644
def send_all(socket, bytes, report_activity=None):
2072
def send_all(sock, bytes, report_activity=None):
1645
2073
"""Send all bytes on a socket.
1647
Regular socket.sendall() can give socket error 10053 on Windows. This
1648
implementation sends no more than 64k at a time, which avoids this problem.
2075
Breaks large blocks in smaller chunks to avoid buffering limitations on
2076
some platforms, and catches EINTR which may be thrown if the send is
2077
interrupted by a signal.
2079
This is preferred to socket.sendall(), because it avoids portability bugs
2080
and provides activity reporting.
1650
2082
:param report_activity: Call this as bytes are read, see
1651
2083
Transport._report_activity
1654
for pos in xrange(0, len(bytes), chunk_size):
1655
block = bytes[pos:pos+chunk_size]
1656
if report_activity is not None:
1657
report_activity(len(block), 'write')
1658
until_no_eintr(socket.sendall, block)
2086
byte_count = len(bytes)
2087
while sent_total < byte_count:
2089
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2090
except socket.error, e:
2091
if e.args[0] != errno.EINTR:
2095
report_activity(sent, 'write')
2098
def connect_socket(address):
2099
# Slight variation of the socket.create_connection() function (provided by
2100
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2101
# provide it for previous python versions. Also, we don't use the timeout
2102
# parameter (provided by the python implementation) so we don't implement
2104
err = socket.error('getaddrinfo returns an empty list')
2105
host, port = address
2106
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2107
af, socktype, proto, canonname, sa = res
2110
sock = socket.socket(af, socktype, proto)
2114
except socket.error, err:
2115
# 'err' is now the most recent error
2116
if sock is not None:
1661
2121
def dereference_path(path):
1780
2257
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2260
if sys.platform == 'linux2':
2261
def _local_concurrency():
2263
return os.sysconf('SC_NPROCESSORS_ONLN')
2264
except (ValueError, OSError, AttributeError):
2266
elif sys.platform == 'darwin':
2267
def _local_concurrency():
2268
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2269
stdout=subprocess.PIPE).communicate()[0]
2270
elif "bsd" in sys.platform:
2271
def _local_concurrency():
2272
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2273
stdout=subprocess.PIPE).communicate()[0]
2274
elif sys.platform == 'sunos5':
2275
def _local_concurrency():
2276
return subprocess.Popen(['psrinfo', '-p',],
2277
stdout=subprocess.PIPE).communicate()[0]
2278
elif sys.platform == "win32":
2279
def _local_concurrency():
2280
# This appears to return the number of cores.
2281
return os.environ.get('NUMBER_OF_PROCESSORS')
2283
def _local_concurrency():
2288
_cached_local_concurrency = None
2290
def local_concurrency(use_cache=True):
2291
"""Return how many processes can be run concurrently.
2293
Rely on platform specific implementations and default to 1 (one) if
2294
anything goes wrong.
2296
global _cached_local_concurrency
2298
if _cached_local_concurrency is not None and use_cache:
2299
return _cached_local_concurrency
2301
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2302
if concurrency is None:
2304
import multiprocessing
2306
# multiprocessing is only available on Python >= 2.6
2308
concurrency = _local_concurrency()
2309
except (OSError, IOError):
2312
concurrency = multiprocessing.cpu_count()
2314
concurrency = int(concurrency)
2315
except (TypeError, ValueError):
2318
_cached_concurrency = concurrency
2322
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2323
"""A stream writer that doesn't decode str arguments."""
2325
def __init__(self, encode, stream, errors='strict'):
2326
codecs.StreamWriter.__init__(self, stream, errors)
2327
self.encode = encode
2329
def write(self, object):
2330
if type(object) is str:
2331
self.stream.write(object)
2333
data, _ = self.encode(object, self.errors)
2334
self.stream.write(data)
2336
if sys.platform == 'win32':
2337
def open_file(filename, mode='r', bufsize=-1):
2338
"""This function is used to override the ``open`` builtin.
2340
But it uses O_NOINHERIT flag so the file handle is not inherited by
2341
child processes. Deleting or renaming a closed file opened with this
2342
function is not blocking child processes.
2344
writing = 'w' in mode
2345
appending = 'a' in mode
2346
updating = '+' in mode
2347
binary = 'b' in mode
2350
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2351
# for flags for each modes.
2361
flags |= os.O_WRONLY
2362
flags |= os.O_CREAT | os.O_TRUNC
2367
flags |= os.O_WRONLY
2368
flags |= os.O_CREAT | os.O_APPEND
2373
flags |= os.O_RDONLY
2375
return os.fdopen(os.open(filename, flags), mode, bufsize)
2380
def getuser_unicode():
2381
"""Return the username as unicode.
2384
user_encoding = get_user_encoding()
2385
username = getpass.getuser().decode(user_encoding)
2386
except UnicodeDecodeError:
2387
raise errors.BzrError("Can't decode username as %s." % \
2392
def available_backup_name(base, exists):
2393
"""Find a non-existing backup file name.
2395
This will *not* create anything, this only return a 'free' entry. This
2396
should be used for checking names in a directory below a locked
2397
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2398
Leap) and generally discouraged.
2400
:param base: The base name.
2402
:param exists: A callable returning True if the path parameter exists.
2405
name = "%s.~%d~" % (base, counter)
2408
name = "%s.~%d~" % (base, counter)
2412
def set_fd_cloexec(fd):
2413
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2414
support for this is not available.
2418
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2419
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2420
except (ImportError, AttributeError):
2421
# Either the fcntl module or specific constants are not present
2425
def find_executable_on_path(name):
2426
"""Finds an executable on the PATH.
2428
On Windows, this will try to append each extension in the PATHEXT
2429
environment variable to the name, if it cannot be found with the name
2432
:param name: The base name of the executable.
2433
:return: The path to the executable found or None.
2435
path = os.environ.get('PATH')
2438
path = path.split(os.pathsep)
2439
if sys.platform == 'win32':
2440
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2441
exts = [ext.lower() for ext in exts]
2442
base, ext = os.path.splitext(name)
2444
if ext.lower() not in exts:
2452
f = os.path.join(d, name) + ext
2453
if os.access(f, os.X_OK):
added
removed
bzrlib/osutils.py
