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 (
51
from bzrlib.symbol_versioning import (
56
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
58
56
if sys.version_info < (2, 5):
71
69
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
83
72
# On win32, O_BINARY is used to indicate the file should
84
73
# be opened in binary mode, rather than text mode.
85
74
# On other platforms, O_BINARY doesn't exist, because
86
75
# they always open in binary mode, so it is okay to
87
# OR with 0 on those platforms.
88
# O_NOINHERIT and O_TEXT exists only on win32 too.
76
# OR with 0 on those platforms
89
77
O_BINARY = getattr(os, 'O_BINARY', 0)
90
O_TEXT = getattr(os, 'O_TEXT', 0)
91
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
94
80
def get_unicode_argv():
321
294
# /path => C:/path
322
295
path = unicode(path)
323
296
# check for absolute path
324
drive = ntpath.splitdrive(path)[0]
297
drive = _nt_splitdrive(path)[0]
325
298
if drive == '' and path[:2] not in('//','\\\\'):
326
299
cwd = os.getcwdu()
327
300
# we cannot simply os.path.join cwd and path
328
301
# because os.path.join('C:','/path') produce '/path'
329
302
# and this is incorrect
330
303
if path[:1] in ('/','\\'):
331
cwd = ntpath.splitdrive(cwd)[0]
304
cwd = _nt_splitdrive(cwd)[0]
333
306
path = cwd + '\\' + path
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
307
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
337
310
def _win32_realpath(path):
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
311
# Real _nt_realpath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
342
315
def _win32_pathjoin(*args):
343
return ntpath.join(*args).replace('\\', '/')
316
return _nt_join(*args).replace('\\', '/')
346
319
def _win32_normpath(path):
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
320
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
350
323
def _win32_getcwd():
930
867
return pathjoin(*p)
933
def parent_directories(filename):
934
"""Return the list of parent directories, deepest first.
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
939
parts = splitpath(dirname(filename))
941
parents.append(joinpath(parts))
946
_extension_load_failures = []
949
def failed_to_load_extension(exception):
950
"""Handle failing to load a binary extension.
952
This should be called from the ImportError block guarding the attempt to
953
import the native extension. If this function returns, the pure-Python
954
implementation should be loaded instead::
957
>>> import bzrlib._fictional_extension_pyx
958
>>> except ImportError, e:
959
>>> bzrlib.osutils.failed_to_load_extension(e)
960
>>> import bzrlib._fictional_extension_py
962
# NB: This docstring is just an example, not a doctest, because doctest
963
# currently can't cope with the use of lazy imports in this namespace --
966
# This currently doesn't report the failure at the time it occurs, because
967
# they tend to happen very early in startup when we can't check config
968
# files etc, and also we want to report all failures but not spam the user
970
from bzrlib import trace
971
exception_str = str(exception)
972
if exception_str not in _extension_load_failures:
973
trace.mutter("failed to load compiled extension: %s" % exception_str)
974
_extension_load_failures.append(exception_str)
977
def report_extension_load_failures():
978
if not _extension_load_failures:
980
from bzrlib.config import GlobalConfig
981
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
983
# the warnings framework should by default show this only once
984
from bzrlib.trace import warning
986
"bzr: warning: some compiled extensions could not be loaded; "
987
"see <https://answers.launchpad.net/bzr/+faq/703>")
988
# we no longer show the specific missing extensions here, because it makes
989
# the message too long and scary - see
990
# https://bugs.launchpad.net/bzr/+bug/430529
994
871
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
995
except ImportError, e:
996
failed_to_load_extension(e)
997
873
from bzrlib._chunks_to_lines_py import chunks_to_lines
1037
913
shutil.copyfile(src, dest)
916
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
917
# Forgiveness than Permission (EAFP) because:
918
# - root can damage a solaris file system by using unlink,
919
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
920
# EACCES, OSX: EPERM) when invoked on a directory.
1040
921
def delete_any(path):
1041
"""Delete a file, symlink or directory.
1043
Will delete even if readonly.
1046
_delete_file_or_dir(path)
1047
except (OSError, IOError), e:
1048
if e.errno in (errno.EPERM, errno.EACCES):
1049
# make writable and try again
1052
except (OSError, IOError):
1054
_delete_file_or_dir(path)
1059
def _delete_file_or_dir(path):
1060
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1061
# Forgiveness than Permission (EAFP) because:
1062
# - root can damage a solaris file system by using unlink,
1063
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1064
# EACCES, OSX: EPERM) when invoked on a directory.
922
"""Delete a file or directory."""
1065
923
if isdir(path): # Takes care of symlinks
1374
1206
normalized_filename = _inaccessible_normalized_filename
1377
def set_signal_handler(signum, handler, restart_syscall=True):
1378
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1379
on platforms that support that.
1381
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1382
automatically restart (by calling `signal.siginterrupt(signum,
1383
False)`). May be ignored if the feature is not available on this
1384
platform or Python version.
1388
siginterrupt = signal.siginterrupt
1390
# This python implementation doesn't provide signal support, hence no
1393
except AttributeError:
1394
# siginterrupt doesn't exist on this platform, or for this version
1396
siginterrupt = lambda signum, flag: None
1398
def sig_handler(*args):
1399
# Python resets the siginterrupt flag when a signal is
1400
# received. <http://bugs.python.org/issue8354>
1401
# As a workaround for some cases, set it back the way we want it.
1402
siginterrupt(signum, False)
1403
# Now run the handler function passed to set_signal_handler.
1406
sig_handler = handler
1407
old_handler = signal.signal(signum, sig_handler)
1409
siginterrupt(signum, False)
1413
default_terminal_width = 80
1414
"""The default terminal width for ttys.
1416
This is defined so that higher levels can share a common fallback value when
1417
terminal_width() returns None.
1420
# Keep some state so that terminal_width can detect if _terminal_size has
1421
# returned a different size since the process started. See docstring and
1422
# comments of terminal_width for details.
1423
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1424
_terminal_size_state = 'no_data'
1425
_first_terminal_size = None
1427
1209
def terminal_width():
1428
"""Return terminal width.
1430
None is returned if the width can't established precisely.
1433
- if BZR_COLUMNS is set, returns its value
1434
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1437
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1440
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1444
- get termios.TIOCGWINSZ
1445
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1448
- win32utils.get_console_size() decides,
1449
- returns None on error (provided default value)
1451
# Note to implementors: if changing the rules for determining the width,
1452
# make sure you've considered the behaviour in these cases:
1453
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1454
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1456
# - (add more interesting cases here, if you find any)
1457
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1458
# but we don't want to register a signal handler because it is impossible
1459
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1460
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1461
# time so we can notice if the reported size has changed, which should have
1464
# If BZR_COLUMNS is set, take it, user is always right
1466
return int(os.environ['BZR_COLUMNS'])
1467
except (KeyError, ValueError):
1470
isatty = getattr(sys.stdout, 'isatty', None)
1471
if isatty is None or not isatty():
1472
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1476
width, height = os_size = _terminal_size(None, None)
1477
global _first_terminal_size, _terminal_size_state
1478
if _terminal_size_state == 'no_data':
1479
_first_terminal_size = os_size
1480
_terminal_size_state = 'unchanged'
1481
elif (_terminal_size_state == 'unchanged' and
1482
_first_terminal_size != os_size):
1483
_terminal_size_state = 'changed'
1485
# If the OS claims to know how wide the terminal is, and this value has
1486
# ever changed, use that.
1487
if _terminal_size_state == 'changed':
1488
if width is not None and width > 0:
1491
# If COLUMNS is set, use it.
1493
return int(os.environ['COLUMNS'])
1494
except (KeyError, ValueError):
1497
# Finally, use an unchanged size from the OS, if we have one.
1498
if _terminal_size_state == 'unchanged':
1499
if width is not None and width > 0:
1502
# The width could not be determined.
1506
def _win32_terminal_size(width, height):
1507
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1508
return width, height
1511
def _ioctl_terminal_size(width, height):
1210
"""Return estimated terminal width."""
1211
if sys.platform == 'win32':
1212
return win32utils.get_console_size()[0]
1513
1215
import struct, fcntl, termios
1514
1216
s = struct.pack('HHHH', 0, 0, 0, 0)
1515
1217
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1516
height, width = struct.unpack('HHHH', x)[0:2]
1517
except (IOError, AttributeError):
1218
width = struct.unpack('HHHH', x)[1]
1519
return width, height
1521
_terminal_size = None
1522
"""Returns the terminal size as (width, height).
1524
:param width: Default value for width.
1525
:param height: Default value for height.
1527
This is defined specifically for each OS and query the size of the controlling
1528
terminal. If any error occurs, the provided default values should be returned.
1530
if sys.platform == 'win32':
1531
_terminal_size = _win32_terminal_size
1533
_terminal_size = _ioctl_terminal_size
1223
width = int(os.environ['COLUMNS'])
1536
1232
def supports_executable():
1987
1656
return socket.gethostname().decode(get_user_encoding())
1990
# We must not read/write any more than 64k at a time from/to a socket so we
1991
# don't risk "no buffer space available" errors on some platforms. Windows in
1992
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1994
MAX_SOCKET_CHUNK = 64 * 1024
1996
def read_bytes_from_socket(sock, report_activity=None,
1997
max_read_size=MAX_SOCKET_CHUNK):
1998
"""Read up to max_read_size of bytes from sock and notify of progress.
2000
Translates "Connection reset by peer" into file-like EOF (return an
2001
empty string rather than raise an error), and repeats the recv if
2002
interrupted by a signal.
2006
bytes = sock.recv(max_read_size)
2007
except socket.error, e:
2009
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2010
# The connection was closed by the other side. Callers expect
2011
# an empty string to signal end-of-stream.
2013
elif eno == errno.EINTR:
2014
# Retry the interrupted recv.
2018
if report_activity is not None:
2019
report_activity(len(bytes), 'read')
2023
def recv_all(socket, count):
1659
def recv_all(socket, bytes):
2024
1660
"""Receive an exact number of bytes.
2026
1662
Regular Socket.recv() may return less than the requested number of bytes,
2027
depending on what's in the OS buffer. MSG_WAITALL is not available
1663
dependning on what's in the OS buffer. MSG_WAITALL is not available
2028
1664
on all platforms, but this should work everywhere. This will return
2029
1665
less than the requested amount if the remote end closes.
2031
1667
This isn't optimized and is intended mostly for use in testing.
2034
while len(b) < count:
2035
new = read_bytes_from_socket(socket, None, count - len(b))
1670
while len(b) < bytes:
1671
new = until_no_eintr(socket.recv, bytes - len(b))
2042
def send_all(sock, bytes, report_activity=None):
1678
def send_all(socket, bytes, report_activity=None):
2043
1679
"""Send all bytes on a socket.
2045
Breaks large blocks in smaller chunks to avoid buffering limitations on
2046
some platforms, and catches EINTR which may be thrown if the send is
2047
interrupted by a signal.
2049
This is preferred to socket.sendall(), because it avoids portability bugs
2050
and provides activity reporting.
1681
Regular socket.sendall() can give socket error 10053 on Windows. This
1682
implementation sends no more than 64k at a time, which avoids this problem.
2052
1684
:param report_activity: Call this as bytes are read, see
2053
1685
Transport._report_activity
2056
byte_count = len(bytes)
2057
while sent_total < byte_count:
2059
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2060
except socket.error, e:
2061
if e.args[0] != errno.EINTR:
2065
report_activity(sent, 'write')
1688
for pos in xrange(0, len(bytes), chunk_size):
1689
block = bytes[pos:pos+chunk_size]
1690
if report_activity is not None:
1691
report_activity(len(block), 'write')
1692
until_no_eintr(socket.sendall, block)
2068
1695
def dereference_path(path):
2204
1814
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2208
if sys.platform == 'linux2':
2209
def _local_concurrency():
2211
prefix = 'processor'
2212
for line in file('/proc/cpuinfo', 'rb'):
2213
if line.startswith(prefix):
2214
concurrency = int(line[line.find(':')+1:]) + 1
2216
elif sys.platform == 'darwin':
2217
def _local_concurrency():
2218
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2219
stdout=subprocess.PIPE).communicate()[0]
2220
elif sys.platform[0:7] == 'freebsd':
2221
def _local_concurrency():
2222
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2223
stdout=subprocess.PIPE).communicate()[0]
2224
elif sys.platform == 'sunos5':
2225
def _local_concurrency():
2226
return subprocess.Popen(['psrinfo', '-p',],
2227
stdout=subprocess.PIPE).communicate()[0]
2228
elif sys.platform == "win32":
2229
def _local_concurrency():
2230
# This appears to return the number of cores.
2231
return os.environ.get('NUMBER_OF_PROCESSORS')
2233
def _local_concurrency():
2238
_cached_local_concurrency = None
2240
def local_concurrency(use_cache=True):
2241
"""Return how many processes can be run concurrently.
2243
Rely on platform specific implementations and default to 1 (one) if
2244
anything goes wrong.
2246
global _cached_local_concurrency
2248
if _cached_local_concurrency is not None and use_cache:
2249
return _cached_local_concurrency
2251
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2252
if concurrency is None:
2254
concurrency = _local_concurrency()
2255
except (OSError, IOError):
2258
concurrency = int(concurrency)
2259
except (TypeError, ValueError):
2262
_cached_concurrency = concurrency
2266
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2267
"""A stream writer that doesn't decode str arguments."""
2269
def __init__(self, encode, stream, errors='strict'):
2270
codecs.StreamWriter.__init__(self, stream, errors)
2271
self.encode = encode
2273
def write(self, object):
2274
if type(object) is str:
2275
self.stream.write(object)
2277
data, _ = self.encode(object, self.errors)
2278
self.stream.write(data)
2280
if sys.platform == 'win32':
2281
def open_file(filename, mode='r', bufsize=-1):
2282
"""This function is used to override the ``open`` builtin.
2284
But it uses O_NOINHERIT flag so the file handle is not inherited by
2285
child processes. Deleting or renaming a closed file opened with this
2286
function is not blocking child processes.
2288
writing = 'w' in mode
2289
appending = 'a' in mode
2290
updating = '+' in mode
2291
binary = 'b' in mode
2294
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2295
# for flags for each modes.
2305
flags |= os.O_WRONLY
2306
flags |= os.O_CREAT | os.O_TRUNC
2311
flags |= os.O_WRONLY
2312
flags |= os.O_CREAT | os.O_APPEND
2317
flags |= os.O_RDONLY
2319
return os.fdopen(os.open(filename, flags), mode, bufsize)
2324
def getuser_unicode():
2325
"""Return the username as unicode.
2328
user_encoding = get_user_encoding()
2329
username = getpass.getuser().decode(user_encoding)
2330
except UnicodeDecodeError:
2331
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
