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
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
43
from tempfile import (
44
from tempfile import mkdtemp
48
47
from bzrlib import (
54
from bzrlib.i18n import gettext
55
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
57
if sys.version_info < (2, 5):
58
import md5 as _mod_md5
60
import sha as _mod_sha
57
from bzrlib.symbol_versioning import (
62
warn as warn_deprecated,
70
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
73
84
# On win32, O_BINARY is used to indicate the file should
74
85
# be opened in binary mode, rather than text mode.
75
86
# On other platforms, O_BINARY doesn't exist, because
76
87
# they always open in binary mode, so it is okay to
77
# OR with 0 on those platforms
88
# OR with 0 on those platforms.
89
# O_NOINHERIT and O_TEXT exists only on win32 too.
78
90
O_BINARY = getattr(os, 'O_BINARY', 0)
91
O_TEXT = getattr(os, 'O_TEXT', 0)
92
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
81
95
def get_unicode_argv():
92
106
mod = os.lstat(filename).st_mode
93
107
if not stat.S_ISLNK(mod):
94
108
mod = mod & 0777555
95
os.chmod(filename, mod)
109
chmod_if_possible(filename, mod)
98
112
def make_writable(filename):
99
113
mod = os.lstat(filename).st_mode
100
114
if not stat.S_ISLNK(mod):
102
os.chmod(filename, mod)
116
chmod_if_possible(filename, mod)
119
def chmod_if_possible(filename, mode):
120
# Set file mode if that can be safely done.
121
# Sometimes even on unix the filesystem won't allow it - see
122
# https://bugs.launchpad.net/bzr/+bug/606537
124
# It is probably faster to just do the chmod, rather than
125
# doing a stat, and then trying to compare
126
os.chmod(filename, mode)
127
except (IOError, OSError),e:
128
# Permission/access denied seems to commonly happen on smbfs; there's
129
# probably no point warning about it.
130
# <https://bugs.launchpad.net/bzr/+bug/606537>
131
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
132
trace.mutter("ignore error on chmod of %r: %r" % (
105
138
def minimum_path_selection(paths):
244
288
unlink_func(tmp_name)
246
290
rename_func(tmp_name, new)
291
if failure_exc is not None:
293
raise failure_exc[0], failure_exc[1], failure_exc[2]
249
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
250
299
# choke on a Unicode string containing a relative path if
251
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
253
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
254
302
def _posix_abspath(path):
255
303
# jam 20060426 rather than encoding to fsencoding
256
304
# copy posixpath.abspath, but use os.getcwdu instead
257
305
if not posixpath.isabs(path):
258
306
path = posixpath.join(getcwd(), path)
259
return posixpath.normpath(path)
307
return _posix_normpath(path)
262
310
def _posix_realpath(path):
263
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_get_home_dir():
346
"""Get the home directory of the current user as a unicode path"""
347
path = posixpath.expanduser("~")
349
return path.decode(_fs_enc)
350
except UnicodeDecodeError:
351
raise errors.BadFilenameEncoding(path, _fs_enc)
354
def _posix_getuser_unicode():
355
"""Get username from environment or password database as unicode"""
356
name = getpass.getuser()
357
user_encoding = get_user_encoding()
359
return name.decode(user_encoding)
360
except UnicodeDecodeError:
361
raise errors.BzrError("Encoding of username %r is unsupported by %s "
362
"application locale." % (name, user_encoding))
266
365
def _win32_fixdrive(path):
267
366
"""Force drive letters to be consistent.
295
394
# /path => C:/path
296
395
path = unicode(path)
297
396
# check for absolute path
298
drive = _nt_splitdrive(path)[0]
397
drive = ntpath.splitdrive(path)[0]
299
398
if drive == '' and path[:2] not in('//','\\\\'):
300
399
cwd = os.getcwdu()
301
400
# we cannot simply os.path.join cwd and path
302
401
# because os.path.join('C:','/path') produce '/path'
303
402
# and this is incorrect
304
403
if path[:1] in ('/','\\'):
305
cwd = _nt_splitdrive(cwd)[0]
404
cwd = ntpath.splitdrive(cwd)[0]
307
406
path = cwd + '\\' + path
308
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
407
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
311
410
def _win32_realpath(path):
312
# Real _nt_realpath doesn't have a problem with a unicode cwd
313
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
411
# Real ntpath.realpath doesn't have a problem with a unicode cwd
412
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
316
415
def _win32_pathjoin(*args):
317
return _nt_join(*args).replace('\\', '/')
416
return ntpath.join(*args).replace('\\', '/')
320
419
def _win32_normpath(path):
321
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
420
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
324
423
def _win32_getcwd():
1036
_extension_load_failures = []
1039
def failed_to_load_extension(exception):
1040
"""Handle failing to load a binary extension.
1042
This should be called from the ImportError block guarding the attempt to
1043
import the native extension. If this function returns, the pure-Python
1044
implementation should be loaded instead::
1047
>>> import bzrlib._fictional_extension_pyx
1048
>>> except ImportError, e:
1049
>>> bzrlib.osutils.failed_to_load_extension(e)
1050
>>> import bzrlib._fictional_extension_py
1052
# NB: This docstring is just an example, not a doctest, because doctest
1053
# currently can't cope with the use of lazy imports in this namespace --
1056
# This currently doesn't report the failure at the time it occurs, because
1057
# they tend to happen very early in startup when we can't check config
1058
# files etc, and also we want to report all failures but not spam the user
1060
exception_str = str(exception)
1061
if exception_str not in _extension_load_failures:
1062
trace.mutter("failed to load compiled extension: %s" % exception_str)
1063
_extension_load_failures.append(exception_str)
1066
def report_extension_load_failures():
1067
if not _extension_load_failures:
1069
if config.GlobalStack().get('ignore_missing_extensions'):
1071
# the warnings framework should by default show this only once
1072
from bzrlib.trace import warning
1074
"bzr: warning: some compiled extensions could not be loaded; "
1075
"see <https://answers.launchpad.net/bzr/+faq/703>")
1076
# we no longer show the specific missing extensions here, because it makes
1077
# the message too long and scary - see
1078
# https://bugs.launchpad.net/bzr/+bug/430529
885
1082
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1083
except ImportError, e:
1084
failed_to_load_extension(e)
887
1085
from bzrlib._chunks_to_lines_py import chunks_to_lines
927
1125
shutil.copyfile(src, dest)
930
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
931
# Forgiveness than Permission (EAFP) because:
932
# - root can damage a solaris file system by using unlink,
933
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
934
# EACCES, OSX: EPERM) when invoked on a directory.
935
1128
def delete_any(path):
936
"""Delete a file or directory."""
1129
"""Delete a file, symlink or directory.
1131
Will delete even if readonly.
1134
_delete_file_or_dir(path)
1135
except (OSError, IOError), e:
1136
if e.errno in (errno.EPERM, errno.EACCES):
1137
# make writable and try again
1140
except (OSError, IOError):
1142
_delete_file_or_dir(path)
1147
def _delete_file_or_dir(path):
1148
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1149
# Forgiveness than Permission (EAFP) because:
1150
# - root can damage a solaris file system by using unlink,
1151
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1152
# EACCES, OSX: EPERM) when invoked on a directory.
937
1153
if isdir(path): # Takes care of symlinks
1220
1462
normalized_filename = _inaccessible_normalized_filename
1465
def set_signal_handler(signum, handler, restart_syscall=True):
1466
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1467
on platforms that support that.
1469
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1470
automatically restart (by calling `signal.siginterrupt(signum,
1471
False)`). May be ignored if the feature is not available on this
1472
platform or Python version.
1476
siginterrupt = signal.siginterrupt
1478
# This python implementation doesn't provide signal support, hence no
1481
except AttributeError:
1482
# siginterrupt doesn't exist on this platform, or for this version
1484
siginterrupt = lambda signum, flag: None
1486
def sig_handler(*args):
1487
# Python resets the siginterrupt flag when a signal is
1488
# received. <http://bugs.python.org/issue8354>
1489
# As a workaround for some cases, set it back the way we want it.
1490
siginterrupt(signum, False)
1491
# Now run the handler function passed to set_signal_handler.
1494
sig_handler = handler
1495
old_handler = signal.signal(signum, sig_handler)
1497
siginterrupt(signum, False)
1501
default_terminal_width = 80
1502
"""The default terminal width for ttys.
1504
This is defined so that higher levels can share a common fallback value when
1505
terminal_width() returns None.
1508
# Keep some state so that terminal_width can detect if _terminal_size has
1509
# returned a different size since the process started. See docstring and
1510
# comments of terminal_width for details.
1511
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1512
_terminal_size_state = 'no_data'
1513
_first_terminal_size = None
1223
1515
def terminal_width():
1224
"""Return estimated terminal width."""
1225
if sys.platform == 'win32':
1226
return win32utils.get_console_size()[0]
1516
"""Return terminal width.
1518
None is returned if the width can't established precisely.
1521
- if BZR_COLUMNS is set, returns its value
1522
- if there is no controlling terminal, returns None
1523
- query the OS, if the queried size has changed since the last query,
1525
- if COLUMNS is set, returns its value,
1526
- if the OS has a value (even though it's never changed), return its value.
1528
From there, we need to query the OS to get the size of the controlling
1531
On Unices we query the OS by:
1532
- get termios.TIOCGWINSZ
1533
- if an error occurs or a negative value is obtained, returns None
1535
On Windows we query the OS by:
1536
- win32utils.get_console_size() decides,
1537
- returns None on error (provided default value)
1539
# Note to implementors: if changing the rules for determining the width,
1540
# make sure you've considered the behaviour in these cases:
1541
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1542
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1544
# - (add more interesting cases here, if you find any)
1545
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1546
# but we don't want to register a signal handler because it is impossible
1547
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1548
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1549
# time so we can notice if the reported size has changed, which should have
1552
# If BZR_COLUMNS is set, take it, user is always right
1553
# Except if they specified 0 in which case, impose no limit here
1555
width = int(os.environ['BZR_COLUMNS'])
1556
except (KeyError, ValueError):
1558
if width is not None:
1564
isatty = getattr(sys.stdout, 'isatty', None)
1565
if isatty is None or not isatty():
1566
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1570
width, height = os_size = _terminal_size(None, None)
1571
global _first_terminal_size, _terminal_size_state
1572
if _terminal_size_state == 'no_data':
1573
_first_terminal_size = os_size
1574
_terminal_size_state = 'unchanged'
1575
elif (_terminal_size_state == 'unchanged' and
1576
_first_terminal_size != os_size):
1577
_terminal_size_state = 'changed'
1579
# If the OS claims to know how wide the terminal is, and this value has
1580
# ever changed, use that.
1581
if _terminal_size_state == 'changed':
1582
if width is not None and width > 0:
1585
# If COLUMNS is set, use it.
1587
return int(os.environ['COLUMNS'])
1588
except (KeyError, ValueError):
1591
# Finally, use an unchanged size from the OS, if we have one.
1592
if _terminal_size_state == 'unchanged':
1593
if width is not None and width > 0:
1596
# The width could not be determined.
1600
def _win32_terminal_size(width, height):
1601
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1602
return width, height
1605
def _ioctl_terminal_size(width, height):
1229
1607
import struct, fcntl, termios
1230
1608
s = struct.pack('HHHH', 0, 0, 0, 0)
1231
1609
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1232
width = struct.unpack('HHHH', x)[1]
1610
height, width = struct.unpack('HHHH', x)[0:2]
1611
except (IOError, AttributeError):
1237
width = int(os.environ['COLUMNS'])
1613
return width, height
1615
_terminal_size = None
1616
"""Returns the terminal size as (width, height).
1618
:param width: Default value for width.
1619
:param height: Default value for height.
1621
This is defined specifically for each OS and query the size of the controlling
1622
terminal. If any error occurs, the provided default values should be returned.
1624
if sys.platform == 'win32':
1625
_terminal_size = _win32_terminal_size
1627
_terminal_size = _ioctl_terminal_size
1246
1630
def supports_executable():
1583
1991
_cached_user_encoding = None
1586
def get_user_encoding(use_cache=True):
1994
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1587
1995
"""Find out what the preferred user encoding is.
1589
1997
This is generally the encoding that is used for command line parameters
1590
1998
and file contents. This may be different from the terminal encoding
1591
1999
or the filesystem encoding.
1593
:param use_cache: Enable cache for detected encoding.
1594
(This parameter is turned on by default,
1595
and required only for selftesting)
1597
2001
:return: A string defining the preferred user encoding
1599
2003
global _cached_user_encoding
1600
if _cached_user_encoding is not None and use_cache:
2004
if deprecated_passed(use_cache):
2005
warn_deprecated("use_cache should only have been used for tests",
2006
DeprecationWarning, stacklevel=2)
2007
if _cached_user_encoding is not None:
1601
2008
return _cached_user_encoding
1603
if sys.platform == 'darwin':
1604
# python locale.getpreferredencoding() always return
1605
# 'mac-roman' on darwin. That's a lie.
1606
sys.platform = 'posix'
1608
if os.environ.get('LANG', None) is None:
1609
# If LANG is not set, we end up with 'ascii', which is bad
1610
# ('mac-roman' is more than ascii), so we set a default which
1611
# will give us UTF-8 (which appears to work in all cases on
1612
# OSX). Users are still free to override LANG of course, as
1613
# long as it give us something meaningful. This work-around
1614
# *may* not be needed with python 3k and/or OSX 10.5, but will
1615
# work with them too -- vila 20080908
1616
os.environ['LANG'] = 'en_US.UTF-8'
1619
sys.platform = 'darwin'
2010
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2011
# Use the existing locale settings and call nl_langinfo directly
2012
# rather than going through getpreferredencoding. This avoids
2013
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2014
# possibility of the setlocale call throwing an error.
2015
user_encoding = locale.nl_langinfo(locale.CODESET)
2017
# GZ 2011-12-19: On windows could call GetACP directly instead.
2018
user_encoding = locale.getpreferredencoding(False)
1624
user_encoding = locale.getpreferredencoding()
1625
except locale.Error, e:
1626
sys.stderr.write('bzr: warning: %s\n'
1627
' Could not determine what text encoding to use.\n'
1628
' This error usually means your Python interpreter\n'
1629
' doesn\'t support the locale set by $LANG (%s)\n'
1630
" Continuing with ascii encoding.\n"
1631
% (e, os.environ.get('LANG')))
1632
user_encoding = 'ascii'
1634
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1635
# treat that as ASCII, and not support printing unicode characters to the
1638
# For python scripts run under vim, we get '', so also treat that as ASCII
1639
if user_encoding in (None, 'cp0', ''):
1640
user_encoding = 'ascii'
1644
codecs.lookup(user_encoding)
2021
user_encoding = codecs.lookup(user_encoding).name
2023
if user_encoding not in ("", "cp0"):
1646
2024
sys.stderr.write('bzr: warning:'
1647
2025
' unknown encoding %s.'
1648
2026
' Continuing with ascii encoding.\n'
1649
2027
% user_encoding
1651
user_encoding = 'ascii'
1654
_cached_user_encoding = user_encoding
2029
user_encoding = 'ascii'
2031
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2032
if user_encoding == 'ascii':
2033
if sys.platform == 'darwin':
2034
# OSX is special-cased in Python to have a UTF-8 filesystem
2035
# encoding and previously had LANG set here if not present.
2036
user_encoding = 'utf-8'
2037
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2038
# for some other posix platforms as well.
2040
_cached_user_encoding = user_encoding
1656
2041
return user_encoding
2044
def get_diff_header_encoding():
2045
return get_terminal_encoding()
1659
2048
def get_host_name():
1660
2049
"""Return the current unicode host name.
1663
2052
behaves inconsistently on different platforms.
1665
2054
if sys.platform == "win32":
1667
2055
return win32utils.get_host_name()
1670
2058
return socket.gethostname().decode(get_user_encoding())
1673
def recv_all(socket, bytes):
2061
# We must not read/write any more than 64k at a time from/to a socket so we
2062
# don't risk "no buffer space available" errors on some platforms. Windows in
2063
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2065
MAX_SOCKET_CHUNK = 64 * 1024
2067
_end_of_stream_errors = [errno.ECONNRESET]
2068
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2069
_eno = getattr(errno, _eno, None)
2070
if _eno is not None:
2071
_end_of_stream_errors.append(_eno)
2075
def read_bytes_from_socket(sock, report_activity=None,
2076
max_read_size=MAX_SOCKET_CHUNK):
2077
"""Read up to max_read_size of bytes from sock and notify of progress.
2079
Translates "Connection reset by peer" into file-like EOF (return an
2080
empty string rather than raise an error), and repeats the recv if
2081
interrupted by a signal.
2085
bytes = sock.recv(max_read_size)
2086
except socket.error, e:
2088
if eno in _end_of_stream_errors:
2089
# The connection was closed by the other side. Callers expect
2090
# an empty string to signal end-of-stream.
2092
elif eno == errno.EINTR:
2093
# Retry the interrupted recv.
2097
if report_activity is not None:
2098
report_activity(len(bytes), 'read')
2102
def recv_all(socket, count):
1674
2103
"""Receive an exact number of bytes.
1676
2105
Regular Socket.recv() may return less than the requested number of bytes,
1677
dependning on what's in the OS buffer. MSG_WAITALL is not available
2106
depending on what's in the OS buffer. MSG_WAITALL is not available
1678
2107
on all platforms, but this should work everywhere. This will return
1679
2108
less than the requested amount if the remote end closes.
1681
2110
This isn't optimized and is intended mostly for use in testing.
1684
while len(b) < bytes:
1685
new = until_no_eintr(socket.recv, bytes - len(b))
2113
while len(b) < count:
2114
new = read_bytes_from_socket(socket, None, count - len(b))
1692
def send_all(socket, bytes, report_activity=None):
2121
def send_all(sock, bytes, report_activity=None):
1693
2122
"""Send all bytes on a socket.
1695
Regular socket.sendall() can give socket error 10053 on Windows. This
1696
implementation sends no more than 64k at a time, which avoids this problem.
2124
Breaks large blocks in smaller chunks to avoid buffering limitations on
2125
some platforms, and catches EINTR which may be thrown if the send is
2126
interrupted by a signal.
2128
This is preferred to socket.sendall(), because it avoids portability bugs
2129
and provides activity reporting.
1698
2131
:param report_activity: Call this as bytes are read, see
1699
2132
Transport._report_activity
1702
for pos in xrange(0, len(bytes), chunk_size):
1703
block = bytes[pos:pos+chunk_size]
1704
if report_activity is not None:
1705
report_activity(len(block), 'write')
1706
until_no_eintr(socket.sendall, block)
2135
byte_count = len(bytes)
2136
while sent_total < byte_count:
2138
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2139
except socket.error, e:
2140
if e.args[0] != errno.EINTR:
2144
report_activity(sent, 'write')
2147
def connect_socket(address):
2148
# Slight variation of the socket.create_connection() function (provided by
2149
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2150
# provide it for previous python versions. Also, we don't use the timeout
2151
# parameter (provided by the python implementation) so we don't implement
2153
err = socket.error('getaddrinfo returns an empty list')
2154
host, port = address
2155
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2156
af, socktype, proto, canonname, sa = res
2159
sock = socket.socket(af, socktype, proto)
2163
except socket.error, err:
2164
# 'err' is now the most recent error
2165
if sock is not None:
1709
2170
def dereference_path(path):
1761
2224
from bzrlib._readdir_pyx import UTF8DirReader
1762
2225
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2226
except ImportError, e:
2227
# This is one time where we won't warn that an extension failed to
2228
# load. The extension is never available on Windows anyway.
1764
2229
from bzrlib._readdir_py import (
1765
2230
_kind_from_mode as file_kind_from_stat_mode
1767
2232
return file_kind_from_stat_mode(mode)
1768
2233
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1771
def file_kind(f, _lstat=os.lstat):
2235
def file_stat(f, _lstat=os.lstat):
1773
return file_kind_from_stat_mode(_lstat(f).st_mode)
1774
2239
except OSError, e:
1775
2240
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1776
2241
raise errors.NoSuchFile(f)
2244
def file_kind(f, _lstat=os.lstat):
2245
stat_value = file_stat(f, _lstat)
2246
return file_kind_from_stat_mode(stat_value.st_mode)
1780
2248
def until_no_eintr(f, *a, **kw):
1781
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
2249
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2251
WARNING: you must be certain that it is safe to retry the call repeatedly
2252
if EINTR does occur. This is typically only true for low-level operations
2253
like os.read. If in any doubt, don't use this.
2255
Keep in mind that this is not a complete solution to EINTR. There is
2256
probably code in the Python standard library and other dependencies that
2257
may encounter EINTR if a signal arrives (and there is signal handler for
2258
that signal). So this function can reduce the impact for IO that bzrlib
2259
directly controls, but it is not a complete solution.
1782
2261
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
1883
2371
_cached_concurrency = concurrency
1884
2372
return concurrency
2375
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2376
"""A stream writer that doesn't decode str arguments."""
2378
def __init__(self, encode, stream, errors='strict'):
2379
codecs.StreamWriter.__init__(self, stream, errors)
2380
self.encode = encode
2382
def write(self, object):
2383
if type(object) is str:
2384
self.stream.write(object)
2386
data, _ = self.encode(object, self.errors)
2387
self.stream.write(data)
2389
if sys.platform == 'win32':
2390
def open_file(filename, mode='r', bufsize=-1):
2391
"""This function is used to override the ``open`` builtin.
2393
But it uses O_NOINHERIT flag so the file handle is not inherited by
2394
child processes. Deleting or renaming a closed file opened with this
2395
function is not blocking child processes.
2397
writing = 'w' in mode
2398
appending = 'a' in mode
2399
updating = '+' in mode
2400
binary = 'b' in mode
2403
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2404
# for flags for each modes.
2414
flags |= os.O_WRONLY
2415
flags |= os.O_CREAT | os.O_TRUNC
2420
flags |= os.O_WRONLY
2421
flags |= os.O_CREAT | os.O_APPEND
2426
flags |= os.O_RDONLY
2428
return os.fdopen(os.open(filename, flags), mode, bufsize)
2433
def available_backup_name(base, exists):
2434
"""Find a non-existing backup file name.
2436
This will *not* create anything, this only return a 'free' entry. This
2437
should be used for checking names in a directory below a locked
2438
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2439
Leap) and generally discouraged.
2441
:param base: The base name.
2443
:param exists: A callable returning True if the path parameter exists.
2446
name = "%s.~%d~" % (base, counter)
2449
name = "%s.~%d~" % (base, counter)
2453
def set_fd_cloexec(fd):
2454
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2455
support for this is not available.
2459
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2460
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2461
except (ImportError, AttributeError):
2462
# Either the fcntl module or specific constants are not present
2466
def find_executable_on_path(name):
2467
"""Finds an executable on the PATH.
2469
On Windows, this will try to append each extension in the PATHEXT
2470
environment variable to the name, if it cannot be found with the name
2473
:param name: The base name of the executable.
2474
:return: The path to the executable found or None.
2476
path = os.environ.get('PATH')
2479
path = path.split(os.pathsep)
2480
if sys.platform == 'win32':
2481
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2482
exts = [ext.lower() for ext in exts]
2483
base, ext = os.path.splitext(name)
2485
if ext.lower() not in exts:
2493
f = os.path.join(d, name) + ext
2494
if os.access(f, os.X_OK):
2499
def _posix_is_local_pid_dead(pid):
2500
"""True if pid doesn't correspond to live process on this machine"""
2502
# Special meaning of unix kill: just check if it's there.
2505
if e.errno == errno.ESRCH:
2506
# On this machine, and really not found: as sure as we can be
2509
elif e.errno == errno.EPERM:
2510
# exists, though not ours
2513
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2514
# Don't really know.
2517
# Exists and our process: not dead.
2520
if sys.platform == "win32":
2521
is_local_pid_dead = win32utils.is_local_pid_dead
2523
is_local_pid_dead = _posix_is_local_pid_dead
2526
def fdatasync(fileno):
2527
"""Flush file contents to disk if possible.
2529
:param fileno: Integer OS file handle.
2530
:raises TransportNotPossible: If flushing to disk is not possible.
2532
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2537
def ensure_empty_directory_exists(path, exception_class):
2538
"""Make sure a local directory exists and is empty.
2540
If it does not exist, it is created. If it exists and is not empty, an
2541
instance of exception_class is raised.
2546
if e.errno != errno.EEXIST:
2548
if os.listdir(path) != []:
2549
raise exception_class(path)
2552
def is_environment_error(evalue):
2553
"""True if exception instance is due to a process environment issue
2555
This includes OSError and IOError, but also other errors that come from
2556
the operating system or core libraries but are not subclasses of those.
2558
if isinstance(evalue, (EnvironmentError, select.error)):
2560
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
