13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
25
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
28
29
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,
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
42
from tempfile import (
44
from tempfile import mkdtemp
47
47
from bzrlib import (
54
from bzrlib.i18n import gettext
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
57
from bzrlib.symbol_versioning import (
62
warn as warn_deprecated,
69
from bzrlib import symbol_versioning
72
from bzrlib import symbol_versioning, _fs_enc
75
# Cross platform wall-clock time functionality with decent resolution.
76
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
77
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
78
# synchronized with ``time.time()``, this is only meant to be used to find
79
# delta times by subtracting from another call to this function.
80
timer_func = time.time
81
if sys.platform == 'win32':
82
timer_func = time.clock
72
84
# On win32, O_BINARY is used to indicate the file should
73
85
# be opened in binary mode, rather than text mode.
74
86
# On other platforms, O_BINARY doesn't exist, because
75
87
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
88
# OR with 0 on those platforms.
89
# O_NOINHERIT and O_TEXT exists only on win32 too.
77
90
O_BINARY = getattr(os, 'O_BINARY', 0)
91
O_TEXT = getattr(os, 'O_TEXT', 0)
92
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
95
def get_unicode_argv():
97
user_encoding = get_user_encoding()
98
return [a.decode(user_encoding) for a in sys.argv[1:]]
99
except UnicodeDecodeError:
100
raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
"application locale.").format(a, user_encoding))
80
104
def make_readonly(filename):
228
288
unlink_func(tmp_name)
230
290
rename_func(tmp_name, new)
291
if failure_exc is not None:
293
raise failure_exc[0], failure_exc[1], failure_exc[2]
233
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
234
299
# choke on a Unicode string containing a relative path if
235
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
237
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
238
302
def _posix_abspath(path):
239
303
# jam 20060426 rather than encoding to fsencoding
240
304
# copy posixpath.abspath, but use os.getcwdu instead
241
305
if not posixpath.isabs(path):
242
306
path = posixpath.join(getcwd(), path)
243
return posixpath.normpath(path)
307
return _posix_normpath(path)
246
310
def _posix_realpath(path):
247
311
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))
250
356
def _win32_fixdrive(path):
251
357
"""Force drive letters to be consistent.
808
raise errors.BzrError("sorry, %r not allowed in path" % f)
997
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
809
998
elif (f == '.') or (f == ''):
815
1005
def joinpath(p):
817
1007
if (f == '..') or (f is None) or (f == ''):
818
raise errors.BzrError("sorry, %r not allowed in path" % f)
1008
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
819
1009
return pathjoin(*p)
1012
def parent_directories(filename):
1013
"""Return the list of parent directories, deepest first.
1015
For example, parent_directories("a/b/c") -> ["a/b", "a"].
1018
parts = splitpath(dirname(filename))
1020
parents.append(joinpath(parts))
1025
_extension_load_failures = []
1028
def failed_to_load_extension(exception):
1029
"""Handle failing to load a binary extension.
1031
This should be called from the ImportError block guarding the attempt to
1032
import the native extension. If this function returns, the pure-Python
1033
implementation should be loaded instead::
1036
>>> import bzrlib._fictional_extension_pyx
1037
>>> except ImportError, e:
1038
>>> bzrlib.osutils.failed_to_load_extension(e)
1039
>>> import bzrlib._fictional_extension_py
1041
# NB: This docstring is just an example, not a doctest, because doctest
1042
# currently can't cope with the use of lazy imports in this namespace --
1045
# This currently doesn't report the failure at the time it occurs, because
1046
# they tend to happen very early in startup when we can't check config
1047
# files etc, and also we want to report all failures but not spam the user
1049
exception_str = str(exception)
1050
if exception_str not in _extension_load_failures:
1051
trace.mutter("failed to load compiled extension: %s" % exception_str)
1052
_extension_load_failures.append(exception_str)
1055
def report_extension_load_failures():
1056
if not _extension_load_failures:
1058
if config.GlobalStack().get('ignore_missing_extensions'):
1060
# the warnings framework should by default show this only once
1061
from bzrlib.trace import warning
1063
"bzr: warning: some compiled extensions could not be loaded; "
1064
"see <https://answers.launchpad.net/bzr/+faq/703>")
1065
# we no longer show the specific missing extensions here, because it makes
1066
# the message too long and scary - see
1067
# https://bugs.launchpad.net/bzr/+bug/430529
1071
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1072
except ImportError, e:
1073
failed_to_load_extension(e)
1074
from bzrlib._chunks_to_lines_py import chunks_to_lines
822
1077
def split_lines(s):
823
1078
"""Split s into lines, but without removing the newline characters."""
1079
# Trivially convert a fulltext into a 'chunked' representation, and let
1080
# chunks_to_lines do the heavy lifting.
1081
if isinstance(s, str):
1082
# chunks_to_lines only supports 8-bit strings
1083
return chunks_to_lines([s])
1085
return _split_lines(s)
1088
def _split_lines(s):
1089
"""Split s into lines, but without removing the newline characters.
1091
This supports Unicode or plain string objects.
824
1093
lines = s.split('\n')
825
1094
result = [line + '\n' for line in lines[:-1]]
915
1216
os.path.commonprefix (python2.4) has a bad bug that it works just
916
1217
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
917
1218
avoids that problem.
1220
NOTE: `base` should not have a trailing slash otherwise you'll get
1221
PathNotChild exceptions regardless of `path`.
920
1224
if len(base) < MIN_ABS_PATHLENGTH:
921
1225
# must have space for e.g. a drive letter
922
raise ValueError('%r is too short to calculate a relative path'
1226
raise ValueError(gettext('%r is too short to calculate a relative path')
925
1229
rp = abspath(path)
929
while len(head) >= len(base):
1234
if len(head) <= len(base) and head != base:
1235
raise errors.PathNotChild(rp, base)
930
1236
if head == base:
932
head, tail = os.path.split(head)
1238
head, tail = split(head)
936
raise errors.PathNotChild(rp, base)
1243
return pathjoin(*reversed(s))
1248
def _cicp_canonical_relpath(base, path):
1249
"""Return the canonical path relative to base.
1251
Like relpath, but on case-insensitive-case-preserving file-systems, this
1252
will return the relpath as stored on the file-system rather than in the
1253
case specified in the input string, for all existing portions of the path.
1255
This will cause O(N) behaviour if called for every path in a tree; if you
1256
have a number of paths to convert, you should use canonical_relpaths().
1258
# TODO: it should be possible to optimize this for Windows by using the
1259
# win32 API FindFiles function to look for the specified name - but using
1260
# os.listdir() still gives us the correct, platform agnostic semantics in
1263
rel = relpath(base, path)
1264
# '.' will have been turned into ''
1268
abs_base = abspath(base)
1270
_listdir = os.listdir
1272
# use an explicit iterator so we can easily consume the rest on early exit.
1273
bit_iter = iter(rel.split('/'))
1274
for bit in bit_iter:
1277
next_entries = _listdir(current)
1278
except OSError: # enoent, eperm, etc
1279
# We can't find this in the filesystem, so just append the
1281
current = pathjoin(current, bit, *list(bit_iter))
1283
for look in next_entries:
1284
if lbit == look.lower():
1285
current = pathjoin(current, look)
1288
# got to the end, nothing matched, so we just return the
1289
# non-existing bits as they were specified (the filename may be
1290
# the target of a move, for example).
1291
current = pathjoin(current, bit, *list(bit_iter))
1293
return current[len(abs_base):].lstrip('/')
1295
# XXX - TODO - we need better detection/integration of case-insensitive
1296
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1297
# filesystems), for example, so could probably benefit from the same basic
1298
# support there. For now though, only Windows and OSX get that support, and
1299
# they get it for *all* file-systems!
1300
if sys.platform in ('win32', 'darwin'):
1301
canonical_relpath = _cicp_canonical_relpath
1303
canonical_relpath = relpath
1305
def canonical_relpaths(base, paths):
1306
"""Create an iterable to canonicalize a sequence of relative paths.
1308
The intent is for this implementation to use a cache, vastly speeding
1309
up multiple transformations in the same directory.
1311
# but for now, we haven't optimized...
1312
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)
944
1330
def safe_unicode(unicode_or_utf8_string):
945
1331
"""Coerce unicode_or_utf8_string into unicode.
947
1333
If it is unicode, it is returned.
948
Otherwise it is decoded from utf-8. If a decoding error
949
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
950
as a BzrBadParameter exception.
1334
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1335
wrapped in a BzrBadParameterNotUnicode exception.
952
1337
if isinstance(unicode_or_utf8_string, unicode):
953
1338
return unicode_or_utf8_string
1066
1451
normalized_filename = _inaccessible_normalized_filename
1454
def set_signal_handler(signum, handler, restart_syscall=True):
1455
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1456
on platforms that support that.
1458
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1459
automatically restart (by calling `signal.siginterrupt(signum,
1460
False)`). May be ignored if the feature is not available on this
1461
platform or Python version.
1465
siginterrupt = signal.siginterrupt
1467
# This python implementation doesn't provide signal support, hence no
1470
except AttributeError:
1471
# siginterrupt doesn't exist on this platform, or for this version
1473
siginterrupt = lambda signum, flag: None
1475
def sig_handler(*args):
1476
# Python resets the siginterrupt flag when a signal is
1477
# received. <http://bugs.python.org/issue8354>
1478
# As a workaround for some cases, set it back the way we want it.
1479
siginterrupt(signum, False)
1480
# Now run the handler function passed to set_signal_handler.
1483
sig_handler = handler
1484
old_handler = signal.signal(signum, sig_handler)
1486
siginterrupt(signum, False)
1490
default_terminal_width = 80
1491
"""The default terminal width for ttys.
1493
This is defined so that higher levels can share a common fallback value when
1494
terminal_width() returns None.
1497
# Keep some state so that terminal_width can detect if _terminal_size has
1498
# returned a different size since the process started. See docstring and
1499
# comments of terminal_width for details.
1500
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1501
_terminal_size_state = 'no_data'
1502
_first_terminal_size = None
1069
1504
def terminal_width():
1070
"""Return estimated terminal width."""
1071
if sys.platform == 'win32':
1072
return win32utils.get_console_size()[0]
1505
"""Return terminal width.
1507
None is returned if the width can't established precisely.
1510
- if BZR_COLUMNS is set, returns its value
1511
- if there is no controlling terminal, returns None
1512
- query the OS, if the queried size has changed since the last query,
1514
- if COLUMNS is set, returns its value,
1515
- if the OS has a value (even though it's never changed), return its value.
1517
From there, we need to query the OS to get the size of the controlling
1520
On Unices we query the OS by:
1521
- get termios.TIOCGWINSZ
1522
- if an error occurs or a negative value is obtained, returns None
1524
On Windows we query the OS by:
1525
- win32utils.get_console_size() decides,
1526
- 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
# 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'])
1545
except (KeyError, ValueError):
1547
if width is not None:
1553
isatty = getattr(sys.stdout, 'isatty', None)
1554
if isatty is None or not isatty():
1555
# 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.
1576
return int(os.environ['COLUMNS'])
1577
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:
1585
# The width could not be determined.
1589
def _win32_terminal_size(width, height):
1590
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1591
return width, height
1594
def _ioctl_terminal_size(width, height):
1075
1596
import struct, fcntl, termios
1076
1597
s = struct.pack('HHHH', 0, 0, 0, 0)
1077
1598
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1078
width = struct.unpack('HHHH', x)[1]
1599
height, width = struct.unpack('HHHH', x)[0:2]
1600
except (IOError, AttributeError):
1083
width = int(os.environ['COLUMNS'])
1602
return width, height
1604
_terminal_size = None
1605
"""Returns the terminal size as (width, height).
1607
:param width: Default value for width.
1608
:param height: Default value for height.
1610
This is defined specifically for each OS and query the size of the controlling
1611
terminal. If any error occurs, the provided default values should be returned.
1613
if sys.platform == 'win32':
1614
_terminal_size = _win32_terminal_size
1616
_terminal_size = _ioctl_terminal_size
1092
1619
def supports_executable():
1429
1980
_cached_user_encoding = None
1432
def get_user_encoding(use_cache=True):
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1433
1984
"""Find out what the preferred user encoding is.
1435
1986
This is generally the encoding that is used for command line parameters
1436
1987
and file contents. This may be different from the terminal encoding
1437
1988
or the filesystem encoding.
1439
:param use_cache: Enable cache for detected encoding.
1440
(This parameter is turned on by default,
1441
and required only for selftesting)
1443
1990
:return: A string defining the preferred user encoding
1445
1992
global _cached_user_encoding
1446
if _cached_user_encoding is not None and use_cache:
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:
1447
1997
return _cached_user_encoding
1449
if sys.platform == 'darwin':
1450
# python locale.getpreferredencoding() always return
1451
# 'mac-roman' on darwin. That's a lie.
1452
sys.platform = 'posix'
1454
if os.environ.get('LANG', None) is None:
1455
# If LANG is not set, we end up with 'ascii', which is bad
1456
# ('mac-roman' is more than ascii), so we set a default which
1457
# will give us UTF-8 (which appears to work in all cases on
1458
# OSX). Users are still free to override LANG of course, as
1459
# long as it give us something meaningful. This work-around
1460
# *may* not be needed with python 3k and/or OSX 10.5, but will
1461
# work with them too -- vila 20080908
1462
os.environ['LANG'] = 'en_US.UTF-8'
1465
sys.platform = 'darwin'
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)
2006
# GZ 2011-12-19: On windows could call GetACP directly instead.
2007
user_encoding = locale.getpreferredencoding(False)
1470
user_encoding = locale.getpreferredencoding()
1471
except locale.Error, e:
1472
sys.stderr.write('bzr: warning: %s\n'
1473
' Could not determine what text encoding to use.\n'
1474
' This error usually means your Python interpreter\n'
1475
' doesn\'t support the locale set by $LANG (%s)\n'
1476
" Continuing with ascii encoding.\n"
1477
% (e, os.environ.get('LANG')))
1478
user_encoding = 'ascii'
1480
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1481
# treat that as ASCII, and not support printing unicode characters to the
1484
# For python scripts run under vim, we get '', so also treat that as ASCII
1485
if user_encoding in (None, 'cp0', ''):
1486
user_encoding = 'ascii'
1490
codecs.lookup(user_encoding)
2010
user_encoding = codecs.lookup(user_encoding).name
2012
if user_encoding not in ("", "cp0"):
1492
2013
sys.stderr.write('bzr: warning:'
1493
2014
' unknown encoding %s.'
1494
2015
' Continuing with ascii encoding.\n'
1495
2016
% user_encoding
1497
user_encoding = 'ascii'
1500
_cached_user_encoding = 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
1502
2030
return user_encoding
2033
def get_diff_header_encoding():
2034
return get_terminal_encoding()
1505
2037
def get_host_name():
1506
2038
"""Return the current unicode host name.
1509
2041
behaves inconsistently on different platforms.
1511
2043
if sys.platform == "win32":
1513
2044
return win32utils.get_host_name()
1516
2047
return socket.gethostname().decode(get_user_encoding())
1519
def recv_all(socket, bytes):
2050
# We must not read/write any more than 64k at a time from/to a socket so we
2051
# don't risk "no buffer space available" errors on some platforms. Windows in
2052
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2054
MAX_SOCKET_CHUNK = 64 * 1024
2056
_end_of_stream_errors = [errno.ECONNRESET]
2057
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2058
_eno = getattr(errno, _eno, None)
2059
if _eno is not None:
2060
_end_of_stream_errors.append(_eno)
2064
def read_bytes_from_socket(sock, report_activity=None,
2065
max_read_size=MAX_SOCKET_CHUNK):
2066
"""Read up to max_read_size of bytes from sock and notify of progress.
2068
Translates "Connection reset by peer" into file-like EOF (return an
2069
empty string rather than raise an error), and repeats the recv if
2070
interrupted by a signal.
2074
bytes = sock.recv(max_read_size)
2075
except socket.error, e:
2077
if eno in _end_of_stream_errors:
2078
# The connection was closed by the other side. Callers expect
2079
# an empty string to signal end-of-stream.
2081
elif eno == errno.EINTR:
2082
# Retry the interrupted recv.
2086
if report_activity is not None:
2087
report_activity(len(bytes), 'read')
2091
def recv_all(socket, count):
1520
2092
"""Receive an exact number of bytes.
1522
2094
Regular Socket.recv() may return less than the requested number of bytes,
1523
dependning on what's in the OS buffer. MSG_WAITALL is not available
2095
depending on what's in the OS buffer. MSG_WAITALL is not available
1524
2096
on all platforms, but this should work everywhere. This will return
1525
2097
less than the requested amount if the remote end closes.
1527
2099
This isn't optimized and is intended mostly for use in testing.
1530
while len(b) < bytes:
1531
new = socket.recv(bytes - len(b))
2102
while len(b) < count:
2103
new = read_bytes_from_socket(socket, None, count - len(b))
1538
def send_all(socket, bytes):
2110
def send_all(sock, bytes, report_activity=None):
1539
2111
"""Send all bytes on a socket.
1541
Regular socket.sendall() can give socket error 10053 on Windows. This
1542
implementation sends no more than 64k at a time, which avoids this problem.
2113
Breaks large blocks in smaller chunks to avoid buffering limitations on
2114
some platforms, and catches EINTR which may be thrown if the send is
2115
interrupted by a signal.
2117
This is preferred to socket.sendall(), because it avoids portability bugs
2118
and provides activity reporting.
2120
:param report_activity: Call this as bytes are read, see
2121
Transport._report_activity
1545
for pos in xrange(0, len(bytes), chunk_size):
1546
socket.sendall(bytes[pos:pos+chunk_size])
2124
byte_count = len(bytes)
2125
while sent_total < byte_count:
2127
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2128
except socket.error, e:
2129
if e.args[0] != errno.EINTR:
2133
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:
1549
2159
def dereference_path(path):
1601
2213
from bzrlib._readdir_pyx import UTF8DirReader
1602
2214
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2215
except ImportError, e:
2216
# This is one time where we won't warn that an extension failed to
2217
# load. The extension is never available on Windows anyway.
1604
2218
from bzrlib._readdir_py import (
1605
2219
_kind_from_mode as file_kind_from_stat_mode
1607
2221
return file_kind_from_stat_mode(mode)
1608
2222
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1611
def file_kind(f, _lstat=os.lstat):
2224
def file_stat(f, _lstat=os.lstat):
1613
return file_kind_from_stat_mode(_lstat(f).st_mode)
1614
2228
except OSError, e:
1615
2229
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1616
2230
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
def until_no_eintr(f, *a, **kw):
2238
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2240
WARNING: you must be certain that it is safe to retry the call repeatedly
2241
if EINTR does occur. This is typically only true for low-level operations
2242
like os.read. If in any doubt, don't use this.
2244
Keep in mind that this is not a complete solution to EINTR. There is
2245
probably code in the Python standard library and other dependencies that
2246
may encounter EINTR if a signal arrives (and there is signal handler for
2247
that signal). So this function can reduce the impact for IO that bzrlib
2248
directly controls, but it is not a complete solution.
2250
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2254
except (IOError, OSError), e:
2255
if e.errno == errno.EINTR:
2260
@deprecated_function(deprecated_in((2, 2, 0)))
2261
def re_compile_checked(re_string, flags=0, where=""):
2262
"""Return a compiled re, or raise a sensible error.
2264
This should only be used when compiling user-supplied REs.
2266
:param re_string: Text form of regular expression.
2267
:param flags: eg re.IGNORECASE
2268
:param where: Message explaining to the user the context where
2269
it occurred, eg 'log search filter'.
2271
# from https://bugs.launchpad.net/bzr/+bug/251352
2273
re_obj = re.compile(re_string, flags)
2276
except errors.InvalidPattern, e:
2278
where = ' in ' + where
2279
# despite the name 'error' is a type
2280
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2284
if sys.platform == "win32":
2287
return msvcrt.getch()
2292
fd = sys.stdin.fileno()
2293
settings = termios.tcgetattr(fd)
2296
ch = sys.stdin.read(1)
2298
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2301
if sys.platform.startswith('linux'):
2302
def _local_concurrency():
2304
return os.sysconf('SC_NPROCESSORS_ONLN')
2305
except (ValueError, OSError, AttributeError):
2307
elif sys.platform == 'darwin':
2308
def _local_concurrency():
2309
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2310
stdout=subprocess.PIPE).communicate()[0]
2311
elif "bsd" in sys.platform:
2312
def _local_concurrency():
2313
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2314
stdout=subprocess.PIPE).communicate()[0]
2315
elif sys.platform == 'sunos5':
2316
def _local_concurrency():
2317
return subprocess.Popen(['psrinfo', '-p',],
2318
stdout=subprocess.PIPE).communicate()[0]
2319
elif sys.platform == "win32":
2320
def _local_concurrency():
2321
# This appears to return the number of cores.
2322
return os.environ.get('NUMBER_OF_PROCESSORS')
2324
def _local_concurrency():
2329
_cached_local_concurrency = None
2331
def local_concurrency(use_cache=True):
2332
"""Return how many processes can be run concurrently.
2334
Rely on platform specific implementations and default to 1 (one) if
2335
anything goes wrong.
2337
global _cached_local_concurrency
2339
if _cached_local_concurrency is not None and use_cache:
2340
return _cached_local_concurrency
2342
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2343
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):
2356
concurrency = int(concurrency)
2357
except (TypeError, ValueError):
2360
_cached_concurrency = concurrency
2364
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2365
"""A stream writer that doesn't decode str arguments."""
2367
def __init__(self, encode, stream, errors='strict'):
2368
codecs.StreamWriter.__init__(self, stream, errors)
2369
self.encode = encode
2371
def write(self, object):
2372
if type(object) is str:
2373
self.stream.write(object)
2375
data, _ = self.encode(object, self.errors)
2376
self.stream.write(data)
2378
if sys.platform == 'win32':
2379
def open_file(filename, mode='r', bufsize=-1):
2380
"""This function is used to override the ``open`` builtin.
2382
But it uses O_NOINHERIT flag so the file handle is not inherited by
2383
child processes. Deleting or renaming a closed file opened with this
2384
function is not blocking child processes.
2386
writing = 'w' in mode
2387
appending = 'a' in mode
2388
updating = '+' in mode
2389
binary = 'b' in mode
2392
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2393
# for flags for each modes.
2403
flags |= os.O_WRONLY
2404
flags |= os.O_CREAT | os.O_TRUNC
2409
flags |= os.O_WRONLY
2410
flags |= os.O_CREAT | os.O_APPEND
2415
flags |= os.O_RDONLY
2417
return os.fdopen(os.open(filename, flags), mode, bufsize)
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):
added
removed
bzrlib/osutils.py
