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(), """
27
28
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
40
from tempfile import mkdtemp
42
from tempfile import (
43
47
from bzrlib import (
52
from bzrlib.symbol_versioning import (
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
if sys.version_info < (2, 5):
57
import md5 as _mod_md5
59
import sha as _mod_sha
64
69
from bzrlib import symbol_versioning
67
# Cross platform wall-clock time functionality with decent resolution.
68
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
69
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
70
# synchronized with ``time.time()``, this is only meant to be used to find
71
# delta times by subtracting from another call to this function.
72
timer_func = time.time
73
if sys.platform == 'win32':
74
timer_func = time.clock
76
72
# On win32, O_BINARY is used to indicate the file should
77
73
# be opened in binary mode, rather than text mode.
78
74
# On other platforms, O_BINARY doesn't exist, because
79
75
# they always open in binary mode, so it is okay to
80
# OR with 0 on those platforms.
81
# O_NOINHERIT and O_TEXT exists only on win32 too.
76
# OR with 0 on those platforms
82
77
O_BINARY = getattr(os, 'O_BINARY', 0)
83
O_TEXT = getattr(os, 'O_TEXT', 0)
84
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
87
def get_unicode_argv():
89
user_encoding = get_user_encoding()
90
return [a.decode(user_encoding) for a in sys.argv[1:]]
91
except UnicodeDecodeError:
92
raise errors.BzrError("Parameter %r encoding is unsupported by %s "
93
"application locale." % (a, user_encoding))
96
80
def make_readonly(filename):
317
279
# /path => C:/path
318
280
path = unicode(path)
319
281
# check for absolute path
320
drive = ntpath.splitdrive(path)[0]
282
drive = _nt_splitdrive(path)[0]
321
283
if drive == '' and path[:2] not in('//','\\\\'):
322
284
cwd = os.getcwdu()
323
285
# we cannot simply os.path.join cwd and path
324
286
# because os.path.join('C:','/path') produce '/path'
325
287
# and this is incorrect
326
288
if path[:1] in ('/','\\'):
327
cwd = ntpath.splitdrive(cwd)[0]
289
cwd = _nt_splitdrive(cwd)[0]
329
291
path = cwd + '\\' + path
330
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
292
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
333
295
def _win32_realpath(path):
334
# Real ntpath.realpath doesn't have a problem with a unicode cwd
335
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
296
# Real _nt_realpath doesn't have a problem with a unicode cwd
297
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
300
def _win32_pathjoin(*args):
339
return ntpath.join(*args).replace('\\', '/')
301
return _nt_join(*args).replace('\\', '/')
342
304
def _win32_normpath(path):
343
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
305
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
346
308
def _win32_getcwd():
940
847
return pathjoin(*p)
943
def parent_directories(filename):
944
"""Return the list of parent directories, deepest first.
946
For example, parent_directories("a/b/c") -> ["a/b", "a"].
949
parts = splitpath(dirname(filename))
951
parents.append(joinpath(parts))
956
_extension_load_failures = []
959
def failed_to_load_extension(exception):
960
"""Handle failing to load a binary extension.
962
This should be called from the ImportError block guarding the attempt to
963
import the native extension. If this function returns, the pure-Python
964
implementation should be loaded instead::
967
>>> import bzrlib._fictional_extension_pyx
968
>>> except ImportError, e:
969
>>> bzrlib.osutils.failed_to_load_extension(e)
970
>>> import bzrlib._fictional_extension_py
972
# NB: This docstring is just an example, not a doctest, because doctest
973
# currently can't cope with the use of lazy imports in this namespace --
976
# This currently doesn't report the failure at the time it occurs, because
977
# they tend to happen very early in startup when we can't check config
978
# files etc, and also we want to report all failures but not spam the user
980
exception_str = str(exception)
981
if exception_str not in _extension_load_failures:
982
trace.mutter("failed to load compiled extension: %s" % exception_str)
983
_extension_load_failures.append(exception_str)
986
def report_extension_load_failures():
987
if not _extension_load_failures:
989
if config.GlobalStack().get('ignore_missing_extensions'):
991
# the warnings framework should by default show this only once
992
from bzrlib.trace import warning
994
"bzr: warning: some compiled extensions could not be loaded; "
995
"see <https://answers.launchpad.net/bzr/+faq/703>")
996
# we no longer show the specific missing extensions here, because it makes
997
# the message too long and scary - see
998
# https://bugs.launchpad.net/bzr/+bug/430529
1002
851
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1003
except ImportError, e:
1004
failed_to_load_extension(e)
1005
853
from bzrlib._chunks_to_lines_py import chunks_to_lines
1045
893
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.
1048
901
def delete_any(path):
1049
"""Delete a file, symlink or directory.
1051
Will delete even if readonly.
1054
_delete_file_or_dir(path)
1055
except (OSError, IOError), e:
1056
if e.errno in (errno.EPERM, errno.EACCES):
1057
# make writable and try again
1060
except (OSError, IOError):
1062
_delete_file_or_dir(path)
1067
def _delete_file_or_dir(path):
1068
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1069
# Forgiveness than Permission (EAFP) because:
1070
# - root can damage a solaris file system by using unlink,
1071
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1072
# EACCES, OSX: EPERM) when invoked on a directory.
902
"""Delete a file or directory."""
1073
903
if isdir(path): # Takes care of symlinks
1382
1172
normalized_filename = _inaccessible_normalized_filename
1385
def set_signal_handler(signum, handler, restart_syscall=True):
1386
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1387
on platforms that support that.
1389
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1390
automatically restart (by calling `signal.siginterrupt(signum,
1391
False)`). May be ignored if the feature is not available on this
1392
platform or Python version.
1396
siginterrupt = signal.siginterrupt
1398
# This python implementation doesn't provide signal support, hence no
1401
except AttributeError:
1402
# siginterrupt doesn't exist on this platform, or for this version
1404
siginterrupt = lambda signum, flag: None
1406
def sig_handler(*args):
1407
# Python resets the siginterrupt flag when a signal is
1408
# received. <http://bugs.python.org/issue8354>
1409
# As a workaround for some cases, set it back the way we want it.
1410
siginterrupt(signum, False)
1411
# Now run the handler function passed to set_signal_handler.
1414
sig_handler = handler
1415
old_handler = signal.signal(signum, sig_handler)
1417
siginterrupt(signum, False)
1421
default_terminal_width = 80
1422
"""The default terminal width for ttys.
1424
This is defined so that higher levels can share a common fallback value when
1425
terminal_width() returns None.
1428
# Keep some state so that terminal_width can detect if _terminal_size has
1429
# returned a different size since the process started. See docstring and
1430
# comments of terminal_width for details.
1431
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1432
_terminal_size_state = 'no_data'
1433
_first_terminal_size = None
1435
1175
def terminal_width():
1436
"""Return terminal width.
1438
None is returned if the width can't established precisely.
1441
- if BZR_COLUMNS is set, returns its value
1442
- if there is no controlling terminal, returns None
1443
- query the OS, if the queried size has changed since the last query,
1445
- if COLUMNS is set, returns its value,
1446
- if the OS has a value (even though it's never changed), return its value.
1448
From there, we need to query the OS to get the size of the controlling
1451
On Unices we query the OS by:
1452
- get termios.TIOCGWINSZ
1453
- if an error occurs or a negative value is obtained, returns None
1455
On Windows we query the OS by:
1456
- win32utils.get_console_size() decides,
1457
- returns None on error (provided default value)
1459
# Note to implementors: if changing the rules for determining the width,
1460
# make sure you've considered the behaviour in these cases:
1461
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1462
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1464
# - (add more interesting cases here, if you find any)
1465
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1466
# but we don't want to register a signal handler because it is impossible
1467
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1468
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1469
# time so we can notice if the reported size has changed, which should have
1472
# If BZR_COLUMNS is set, take it, user is always right
1473
# Except if they specified 0 in which case, impose no limit here
1475
width = int(os.environ['BZR_COLUMNS'])
1476
except (KeyError, ValueError):
1478
if width is not None:
1484
isatty = getattr(sys.stdout, 'isatty', None)
1485
if isatty is None or not isatty():
1486
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1490
width, height = os_size = _terminal_size(None, None)
1491
global _first_terminal_size, _terminal_size_state
1492
if _terminal_size_state == 'no_data':
1493
_first_terminal_size = os_size
1494
_terminal_size_state = 'unchanged'
1495
elif (_terminal_size_state == 'unchanged' and
1496
_first_terminal_size != os_size):
1497
_terminal_size_state = 'changed'
1499
# If the OS claims to know how wide the terminal is, and this value has
1500
# ever changed, use that.
1501
if _terminal_size_state == 'changed':
1502
if width is not None and width > 0:
1505
# If COLUMNS is set, use it.
1507
return int(os.environ['COLUMNS'])
1508
except (KeyError, ValueError):
1511
# Finally, use an unchanged size from the OS, if we have one.
1512
if _terminal_size_state == 'unchanged':
1513
if width is not None and width > 0:
1516
# The width could not be determined.
1520
def _win32_terminal_size(width, height):
1521
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1522
return width, height
1525
def _ioctl_terminal_size(width, height):
1176
"""Return estimated terminal width."""
1177
if sys.platform == 'win32':
1178
return win32utils.get_console_size()[0]
1527
1181
import struct, fcntl, termios
1528
1182
s = struct.pack('HHHH', 0, 0, 0, 0)
1529
1183
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1530
height, width = struct.unpack('HHHH', x)[0:2]
1531
except (IOError, AttributeError):
1184
width = struct.unpack('HHHH', x)[1]
1533
return width, height
1535
_terminal_size = None
1536
"""Returns the terminal size as (width, height).
1538
:param width: Default value for width.
1539
:param height: Default value for height.
1541
This is defined specifically for each OS and query the size of the controlling
1542
terminal. If any error occurs, the provided default values should be returned.
1544
if sys.platform == 'win32':
1545
_terminal_size = _win32_terminal_size
1547
_terminal_size = _ioctl_terminal_size
1189
width = int(os.environ['COLUMNS'])
1550
1198
def supports_executable():
2004
1622
return socket.gethostname().decode(get_user_encoding())
2007
# We must not read/write any more than 64k at a time from/to a socket so we
2008
# don't risk "no buffer space available" errors on some platforms. Windows in
2009
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2011
MAX_SOCKET_CHUNK = 64 * 1024
2013
_end_of_stream_errors = [errno.ECONNRESET]
2014
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2015
_eno = getattr(errno, _eno, None)
2016
if _eno is not None:
2017
_end_of_stream_errors.append(_eno)
2021
def read_bytes_from_socket(sock, report_activity=None,
2022
max_read_size=MAX_SOCKET_CHUNK):
2023
"""Read up to max_read_size of bytes from sock and notify of progress.
2025
Translates "Connection reset by peer" into file-like EOF (return an
2026
empty string rather than raise an error), and repeats the recv if
2027
interrupted by a signal.
2031
bytes = sock.recv(max_read_size)
2032
except socket.error, e:
2034
if eno in _end_of_stream_errors:
2035
# The connection was closed by the other side. Callers expect
2036
# an empty string to signal end-of-stream.
2038
elif eno == errno.EINTR:
2039
# Retry the interrupted recv.
2043
if report_activity is not None:
2044
report_activity(len(bytes), 'read')
2048
def recv_all(socket, count):
1625
def recv_all(socket, bytes):
2049
1626
"""Receive an exact number of bytes.
2051
1628
Regular Socket.recv() may return less than the requested number of bytes,
2052
depending on what's in the OS buffer. MSG_WAITALL is not available
1629
dependning on what's in the OS buffer. MSG_WAITALL is not available
2053
1630
on all platforms, but this should work everywhere. This will return
2054
1631
less than the requested amount if the remote end closes.
2056
1633
This isn't optimized and is intended mostly for use in testing.
2059
while len(b) < count:
2060
new = read_bytes_from_socket(socket, None, count - len(b))
1636
while len(b) < bytes:
1637
new = until_no_eintr(socket.recv, bytes - len(b))
2067
def send_all(sock, bytes, report_activity=None):
1644
def send_all(socket, bytes, report_activity=None):
2068
1645
"""Send all bytes on a socket.
2070
Breaks large blocks in smaller chunks to avoid buffering limitations on
2071
some platforms, and catches EINTR which may be thrown if the send is
2072
interrupted by a signal.
2074
This is preferred to socket.sendall(), because it avoids portability bugs
2075
and provides activity reporting.
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.
2077
1650
:param report_activity: Call this as bytes are read, see
2078
1651
Transport._report_activity
2081
byte_count = len(bytes)
2082
while sent_total < byte_count:
2084
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2085
except socket.error, e:
2086
if e.args[0] != errno.EINTR:
2090
report_activity(sent, 'write')
2093
def connect_socket(address):
2094
# Slight variation of the socket.create_connection() function (provided by
2095
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2096
# provide it for previous python versions. Also, we don't use the timeout
2097
# parameter (provided by the python implementation) so we don't implement
2099
err = socket.error('getaddrinfo returns an empty list')
2100
host, port = address
2101
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2102
af, socktype, proto, canonname, sa = res
2105
sock = socket.socket(af, socktype, proto)
2109
except socket.error, err:
2110
# 'err' is now the most recent error
2111
if sock is not None:
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)
2116
1661
def dereference_path(path):
2252
1780
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2255
if sys.platform == 'linux2':
2256
def _local_concurrency():
2258
return os.sysconf('SC_NPROCESSORS_ONLN')
2259
except (ValueError, OSError, AttributeError):
2261
elif sys.platform == 'darwin':
2262
def _local_concurrency():
2263
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2264
stdout=subprocess.PIPE).communicate()[0]
2265
elif "bsd" in sys.platform:
2266
def _local_concurrency():
2267
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2268
stdout=subprocess.PIPE).communicate()[0]
2269
elif sys.platform == 'sunos5':
2270
def _local_concurrency():
2271
return subprocess.Popen(['psrinfo', '-p',],
2272
stdout=subprocess.PIPE).communicate()[0]
2273
elif sys.platform == "win32":
2274
def _local_concurrency():
2275
# This appears to return the number of cores.
2276
return os.environ.get('NUMBER_OF_PROCESSORS')
2278
def _local_concurrency():
2283
_cached_local_concurrency = None
2285
def local_concurrency(use_cache=True):
2286
"""Return how many processes can be run concurrently.
2288
Rely on platform specific implementations and default to 1 (one) if
2289
anything goes wrong.
2291
global _cached_local_concurrency
2293
if _cached_local_concurrency is not None and use_cache:
2294
return _cached_local_concurrency
2296
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2297
if concurrency is None:
2299
import multiprocessing
2301
# multiprocessing is only available on Python >= 2.6
2303
concurrency = _local_concurrency()
2304
except (OSError, IOError):
2307
concurrency = multiprocessing.cpu_count()
2309
concurrency = int(concurrency)
2310
except (TypeError, ValueError):
2313
_cached_concurrency = concurrency
2317
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2318
"""A stream writer that doesn't decode str arguments."""
2320
def __init__(self, encode, stream, errors='strict'):
2321
codecs.StreamWriter.__init__(self, stream, errors)
2322
self.encode = encode
2324
def write(self, object):
2325
if type(object) is str:
2326
self.stream.write(object)
2328
data, _ = self.encode(object, self.errors)
2329
self.stream.write(data)
2331
if sys.platform == 'win32':
2332
def open_file(filename, mode='r', bufsize=-1):
2333
"""This function is used to override the ``open`` builtin.
2335
But it uses O_NOINHERIT flag so the file handle is not inherited by
2336
child processes. Deleting or renaming a closed file opened with this
2337
function is not blocking child processes.
2339
writing = 'w' in mode
2340
appending = 'a' in mode
2341
updating = '+' in mode
2342
binary = 'b' in mode
2345
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2346
# for flags for each modes.
2356
flags |= os.O_WRONLY
2357
flags |= os.O_CREAT | os.O_TRUNC
2362
flags |= os.O_WRONLY
2363
flags |= os.O_CREAT | os.O_APPEND
2368
flags |= os.O_RDONLY
2370
return os.fdopen(os.open(filename, flags), mode, bufsize)
2375
def getuser_unicode():
2376
"""Return the username as unicode.
2379
user_encoding = get_user_encoding()
2380
username = getpass.getuser().decode(user_encoding)
2381
except UnicodeDecodeError:
2382
raise errors.BzrError("Can't decode username as %s." % \
2384
except ImportError, e:
2385
if sys.platform != 'win32':
2387
if str(e) != 'No module named pwd':
2389
# https://bugs.launchpad.net/bzr/+bug/660174
2390
# getpass.getuser() is unable to return username on Windows
2391
# if there is no USERNAME environment variable set.
2392
# That could be true if bzr is running as a service,
2393
# e.g. running `bzr serve` as a service on Windows.
2394
# We should not fail with traceback in this case.
2395
username = u'UNKNOWN'
2399
def available_backup_name(base, exists):
2400
"""Find a non-existing backup file name.
2402
This will *not* create anything, this only return a 'free' entry. This
2403
should be used for checking names in a directory below a locked
2404
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2405
Leap) and generally discouraged.
2407
:param base: The base name.
2409
:param exists: A callable returning True if the path parameter exists.
2412
name = "%s.~%d~" % (base, counter)
2415
name = "%s.~%d~" % (base, counter)
2419
def set_fd_cloexec(fd):
2420
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2421
support for this is not available.
2425
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2426
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2427
except (ImportError, AttributeError):
2428
# Either the fcntl module or specific constants are not present
2432
def find_executable_on_path(name):
2433
"""Finds an executable on the PATH.
2435
On Windows, this will try to append each extension in the PATHEXT
2436
environment variable to the name, if it cannot be found with the name
2439
:param name: The base name of the executable.
2440
:return: The path to the executable found or None.
2442
path = os.environ.get('PATH')
2445
path = path.split(os.pathsep)
2446
if sys.platform == 'win32':
2447
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2448
exts = [ext.lower() for ext in exts]
2449
base, ext = os.path.splitext(name)
2451
if ext.lower() not in exts:
2459
f = os.path.join(d, name) + ext
2460
if os.access(f, os.X_OK):
2465
def _posix_is_local_pid_dead(pid):
2466
"""True if pid doesn't correspond to live process on this machine"""
2468
# Special meaning of unix kill: just check if it's there.
2471
if e.errno == errno.ESRCH:
2472
# On this machine, and really not found: as sure as we can be
2475
elif e.errno == errno.EPERM:
2476
# exists, though not ours
2479
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2480
# Don't really know.
2483
# Exists and our process: not dead.
2486
if sys.platform == "win32":
2487
is_local_pid_dead = win32utils.is_local_pid_dead
2489
is_local_pid_dead = _posix_is_local_pid_dead
2492
def fdatasync(fileno):
2493
"""Flush file contents to disk if possible.
2495
:param fileno: Integer OS file handle.
2496
:raises TransportNotPossible: If flushing to disk is not possible.
2498
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
added
removed
bzrlib/osutils.py
