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)
26
25
from bzrlib.lazy_import import lazy_import
27
26
lazy_import(globals(), """
29
27
from datetime import datetime
31
from ntpath import (abspath as _nt_abspath,
33
normpath as _nt_normpath,
34
realpath as _nt_realpath,
35
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
45
from tempfile import (
40
from tempfile import mkdtemp
50
43
from bzrlib import (
51
from bzrlib.symbol_versioning import (
57
56
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
59
58
if sys.version_info < (2, 5):
85
84
# be opened in binary mode, rather than text mode.
86
85
# On other platforms, O_BINARY doesn't exist, because
87
86
# they always open in binary mode, so it is okay to
88
# OR with 0 on those platforms
87
# OR with 0 on those platforms.
88
# O_NOINHERIT and O_TEXT exists only on win32 too.
89
89
O_BINARY = getattr(os, 'O_BINARY', 0)
90
O_TEXT = getattr(os, 'O_TEXT', 0)
91
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
92
94
def get_unicode_argv():
296
298
running python.exe under cmd.exe return capital C:\\
297
299
running win32 python inside a cygwin shell returns lowercase c:\\
299
drive, path = _nt_splitdrive(path)
301
drive, path = ntpath.splitdrive(path)
300
302
return drive.upper() + path
303
305
def _win32_abspath(path):
304
# Real _nt_abspath doesn't have a problem with a unicode cwd
305
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
308
310
def _win98_abspath(path):
319
321
# /path => C:/path
320
322
path = unicode(path)
321
323
# check for absolute path
322
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
323
325
if drive == '' and path[:2] not in('//','\\\\'):
324
326
cwd = os.getcwdu()
325
327
# we cannot simply os.path.join cwd and path
326
328
# because os.path.join('C:','/path') produce '/path'
327
329
# and this is incorrect
328
330
if path[:1] in ('/','\\'):
329
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
331
333
path = cwd + '\\' + path
332
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
335
337
def _win32_realpath(path):
336
# Real _nt_realpath doesn't have a problem with a unicode cwd
337
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
340
342
def _win32_pathjoin(*args):
341
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
344
346
def _win32_normpath(path):
345
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
348
350
def _win32_getcwd():
452
456
input_encoding = getattr(sys.stdin, 'encoding', None)
453
457
if not input_encoding:
454
458
output_encoding = get_user_encoding()
455
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
458
463
output_encoding = input_encoding
459
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
465
mutter('encoding stdout as sys.stdin encoding %r',
461
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
462
470
if output_encoding == 'cp0':
463
471
# invalid encoding (cp0 means 'no codepage' on Windows)
464
472
output_encoding = get_user_encoding()
465
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
466
475
' encoding stdout as osutils.get_user_encoding() %r',
1222
1234
# but for now, we haven't optimized...
1223
1235
return [canonical_relpath(base, p) for p in paths]
1238
def decode_filename(filename):
1239
"""Decode the filename using the filesystem encoding
1241
If it is unicode, it is returned.
1242
Otherwise it is decoded from the the filesystem's encoding. If decoding
1243
fails, a errors.BadFilenameEncoding exception is raised.
1245
if type(filename) is unicode:
1248
return filename.decode(_fs_enc)
1249
except UnicodeDecodeError:
1250
raise errors.BadFilenameEncoding(filename, _fs_enc)
1225
1253
def safe_unicode(unicode_or_utf8_string):
1226
1254
"""Coerce unicode_or_utf8_string into unicode.
1346
1374
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)
1349
1413
default_terminal_width = 80
1350
1414
"""The default terminal width for ttys.
1363
1433
- if BZR_COLUMNS is set, returns its value
1364
1434
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1365
1437
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1367
1440
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1371
1444
- get termios.TIOCGWINSZ
1372
1445
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1376
1448
- win32utils.get_console_size() decides,
1377
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
1380
1464
# If BZR_COLUMNS is set, take it, user is always right
1386
1470
isatty = getattr(sys.stdout, 'isatty', None)
1387
if isatty is None or not isatty():
1471
if isatty is None or not isatty():
1388
1472
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1391
# If COLUMNS is set, take it, the terminal knows better (even inside a
1392
# given terminal, the application can decide to set COLUMNS to a lower
1393
# value (splitted screen) or a bigger value (scroll bars))
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.
1395
1493
return int(os.environ['COLUMNS'])
1396
1494
except (KeyError, ValueError):
1399
width, height = _terminal_size(None, None)
1401
# Consider invalid values as meaning no width
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.
1407
1506
def _win32_terminal_size(width, height):
1434
1533
_terminal_size = _ioctl_terminal_size
1437
def _terminal_size_changed(signum, frame):
1438
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1439
width, height = _terminal_size(None, None)
1440
if width is not None:
1441
os.environ['COLUMNS'] = str(width)
1443
if sys.platform == 'win32':
1444
# Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from ReadConsoleInput but
1445
# I've no idea how to plug that in the current design -- vila 20091216
1448
signal.signal(signal.SIGWINCH, _terminal_size_changed)
1451
1536
def supports_executable():
1452
1537
return sys.platform != "win32"
1771
1856
real_handlers[kind](abspath, relpath)
1859
def copy_ownership_from_path(dst, src=None):
1860
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1862
If src is None, the containing directory is used as source. If chown
1863
fails, the error is ignored and a warning is printed.
1865
chown = getattr(os, 'chown', None)
1870
src = os.path.dirname(dst)
1876
chown(dst, s.st_uid, s.st_gid)
1878
trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1774
1881
def path_prefix_key(path):
1775
1882
"""Generate a prefix-order path key for path.
1876
1987
return socket.gethostname().decode(get_user_encoding())
1879
def recv_all(socket, bytes):
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):
1880
2024
"""Receive an exact number of bytes.
1882
2026
Regular Socket.recv() may return less than the requested number of bytes,
1883
dependning on what's in the OS buffer. MSG_WAITALL is not available
2027
depending on what's in the OS buffer. MSG_WAITALL is not available
1884
2028
on all platforms, but this should work everywhere. This will return
1885
2029
less than the requested amount if the remote end closes.
1887
2031
This isn't optimized and is intended mostly for use in testing.
1890
while len(b) < bytes:
1891
new = until_no_eintr(socket.recv, bytes - len(b))
2034
while len(b) < count:
2035
new = read_bytes_from_socket(socket, None, count - len(b))
1898
def send_all(socket, bytes, report_activity=None):
2042
def send_all(sock, bytes, report_activity=None):
1899
2043
"""Send all bytes on a socket.
1901
Regular socket.sendall() can give socket error 10053 on Windows. This
1902
implementation sends no more than 64k at a time, which avoids this problem.
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.
1904
2052
:param report_activity: Call this as bytes are read, see
1905
2053
Transport._report_activity
1908
for pos in xrange(0, len(bytes), chunk_size):
1909
block = bytes[pos:pos+chunk_size]
1910
if report_activity is not None:
1911
report_activity(len(block), 'write')
1912
until_no_eintr(socket.sendall, block)
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')
2068
def connect_socket(address):
2069
# Slight variation of the socket.create_connection() function (provided by
2070
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2071
# provide it for previous python versions. Also, we don't use the timeout
2072
# parameter (provided by the python implementation) so we don't implement
2074
err = socket.error('getaddrinfo returns an empty list')
2075
host, port = address
2076
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2077
af, socktype, proto, canonname, sa = res
2080
sock = socket.socket(af, socktype, proto)
2084
except socket.error, err:
2085
# 'err' is now the most recent error
2086
if sock is not None:
1915
2091
def dereference_path(path):
1988
2166
def until_no_eintr(f, *a, **kw):
1989
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
2167
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2169
WARNING: you must be certain that it is safe to retry the call repeatedly
2170
if EINTR does occur. This is typically only true for low-level operations
2171
like os.read. If in any doubt, don't use this.
2173
Keep in mind that this is not a complete solution to EINTR. There is
2174
probably code in the Python standard library and other dependencies that
2175
may encounter EINTR if a signal arrives (and there is signal handler for
2176
that signal). So this function can reduce the impact for IO that bzrlib
2177
directly controls, but it is not a complete solution.
1990
2179
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2109
2300
data, _ = self.encode(object, self.errors)
2110
2301
self.stream.write(data)
2303
if sys.platform == 'win32':
2304
def open_file(filename, mode='r', bufsize=-1):
2305
"""This function is used to override the ``open`` builtin.
2307
But it uses O_NOINHERIT flag so the file handle is not inherited by
2308
child processes. Deleting or renaming a closed file opened with this
2309
function is not blocking child processes.
2311
writing = 'w' in mode
2312
appending = 'a' in mode
2313
updating = '+' in mode
2314
binary = 'b' in mode
2317
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2318
# for flags for each modes.
2328
flags |= os.O_WRONLY
2329
flags |= os.O_CREAT | os.O_TRUNC
2334
flags |= os.O_WRONLY
2335
flags |= os.O_CREAT | os.O_APPEND
2340
flags |= os.O_RDONLY
2342
return os.fdopen(os.open(filename, flags), mode, bufsize)
2347
def getuser_unicode():
2348
"""Return the username as unicode.
2351
user_encoding = get_user_encoding()
2352
username = getpass.getuser().decode(user_encoding)
2353
except UnicodeDecodeError:
2354
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
