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
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
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
40
from tempfile import mkdtemp
45
from tempfile import (
43
50
from bzrlib import (
51
from bzrlib.symbol_versioning import (
56
59
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
58
61
if sys.version_info < (2, 5):
298
301
running python.exe under cmd.exe return capital C:\\
299
302
running win32 python inside a cygwin shell returns lowercase c:\\
301
drive, path = ntpath.splitdrive(path)
304
drive, path = _nt_splitdrive(path)
302
305
return drive.upper() + path
305
308
def _win32_abspath(path):
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
309
# Real _nt_abspath doesn't have a problem with a unicode cwd
310
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
310
313
def _win98_abspath(path):
321
324
# /path => C:/path
322
325
path = unicode(path)
323
326
# check for absolute path
324
drive = ntpath.splitdrive(path)[0]
327
drive = _nt_splitdrive(path)[0]
325
328
if drive == '' and path[:2] not in('//','\\\\'):
326
329
cwd = os.getcwdu()
327
330
# we cannot simply os.path.join cwd and path
328
331
# because os.path.join('C:','/path') produce '/path'
329
332
# and this is incorrect
330
333
if path[:1] in ('/','\\'):
331
cwd = ntpath.splitdrive(cwd)[0]
334
cwd = _nt_splitdrive(cwd)[0]
333
336
path = cwd + '\\' + path
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
337
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
337
340
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('\\', '/'))
341
# Real _nt_realpath doesn't have a problem with a unicode cwd
342
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
342
345
def _win32_pathjoin(*args):
343
return ntpath.join(*args).replace('\\', '/')
346
return _nt_join(*args).replace('\\', '/')
346
349
def _win32_normpath(path):
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
350
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
350
353
def _win32_getcwd():
456
457
input_encoding = getattr(sys.stdin, 'encoding', None)
457
458
if not input_encoding:
458
459
output_encoding = get_user_encoding()
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
463
463
output_encoding = input_encoding
465
mutter('encoding stdout as sys.stdin encoding %r',
464
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
466
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
467
if output_encoding == 'cp0':
471
468
# invalid encoding (cp0 means 'no codepage' on Windows)
472
469
output_encoding = get_user_encoding()
474
mutter('cp0 is invalid encoding.'
470
mutter('cp0 is invalid encoding.'
475
471
' encoding stdout as osutils.get_user_encoding() %r',
1234
1227
# but for now, we haven't optimized...
1235
1228
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)
1253
1230
def safe_unicode(unicode_or_utf8_string):
1254
1231
"""Coerce unicode_or_utf8_string into unicode.
1349
1326
On platforms where the system normalizes filenames (Mac OSX),
1350
1327
you can access a file by any path which will normalize correctly.
1351
1328
On platforms where the system does not normalize filenames
1352
(everything else), you have to access a file by its exact path.
1329
(Windows, Linux), you have to access a file by its exact path.
1354
1331
Internally, bzr only supports NFC normalization, since that is
1355
1332
the standard for XML documents.
1383
1360
False)`). May be ignored if the feature is not available on this
1384
1361
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
1363
old_handler = signal.signal(signum, handler)
1397
1364
if restart_syscall:
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.
1366
siginterrupt = signal.siginterrupt
1367
except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
1402
1371
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)
1410
1372
return old_handler
1433
1389
- if BZR_COLUMNS is set, returns its value
1434
1390
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1437
1391
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1440
1393
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1444
1397
- get termios.TIOCGWINSZ
1445
1398
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1448
1402
- win32utils.get_console_size() decides,
1449
1403
- 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
1406
# If BZR_COLUMNS is set, take it, user is always right
1470
1412
isatty = getattr(sys.stdout, 'isatty', None)
1471
if isatty is None or not isatty():
1413
if isatty is None or not isatty():
1472
1414
# 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.
1417
# If COLUMNS is set, take it, the terminal knows better (even inside a
1418
# given terminal, the application can decide to set COLUMNS to a lower
1419
# value (splitted screen) or a bigger value (scroll bars))
1493
1421
return int(os.environ['COLUMNS'])
1494
1422
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:
1425
width, height = _terminal_size(None, None)
1427
# Consider invalid values as meaning no width
1502
# The width could not be determined.
1506
1433
def _win32_terminal_size(width, height):
1533
1460
_terminal_size = _ioctl_terminal_size
1463
def _terminal_size_changed(signum, frame):
1464
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1465
width, height = _terminal_size(None, None)
1466
if width is not None:
1467
os.environ['COLUMNS'] = str(width)
1470
_registered_sigwinch = False
1472
def watch_sigwinch():
1473
"""Register for SIGWINCH, once and only once."""
1474
global _registered_sigwinch
1475
if not _registered_sigwinch:
1476
if sys.platform == 'win32':
1477
# Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
1478
# ReadConsoleInput but I've no idea how to plug that in
1479
# the current design -- vila 20091216
1482
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1483
_registered_sigwinch = True
1536
1486
def supports_executable():
1537
1487
return sys.platform != "win32"
1856
1806
real_handlers[kind](abspath, relpath)
1859
def copy_ownership_from_path(dst, src=None):
1809
def copy_ownership(dst, src=None):
1860
1810
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1862
1812
If src is None, the containing directory is used as source. If chown
1863
1813
fails, the error is ignored and a warning is printed.
1865
chown = getattr(os, 'chown', None)
1815
has_chown = getattr(os, 'chown')
1816
if has_chown is None: return
1869
1818
if src == None:
1870
1819
src = os.path.dirname(dst)
1875
1824
s = os.stat(src)
1876
chown(dst, s.st_uid, s.st_gid)
1825
os.chown(dst, s.st_uid, s.st_gid)
1877
1826
except OSError, e:
1878
1827
trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1830
def mkdir_with_ownership(path, ownership_src=None):
1831
"""Create the directory 'path' with specified ownership.
1833
If ownership_src is given, copies (chown) usr/grp ownership
1834
from 'ownership_src' to 'path'. If ownership_src is None, use the
1835
containing dir ownership.
1838
copy_ownership(path, ownership_src)
1841
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
1842
"""Open the file 'filename' with the specified ownership.
1844
If ownership_src is specified, copy usr/grp ownership from ownership_src
1845
to filename. If ownership_src is None, copy ownership from containing
1847
Returns the opened file object.
1849
f = open(filename, mode, bufsize)
1850
copy_ownership(filename, ownership_src)
1881
1854
def path_prefix_key(path):
1882
1855
"""Generate a prefix-order path key for path.
1987
1956
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):
1959
def recv_all(socket, bytes):
2024
1960
"""Receive an exact number of bytes.
2026
1962
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
1963
dependning on what's in the OS buffer. MSG_WAITALL is not available
2028
1964
on all platforms, but this should work everywhere. This will return
2029
1965
less than the requested amount if the remote end closes.
2031
1967
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))
1970
while len(b) < bytes:
1971
new = until_no_eintr(socket.recv, bytes - len(b))
2042
def send_all(sock, bytes, report_activity=None):
1978
def send_all(socket, bytes, report_activity=None):
2043
1979
"""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.
1981
Regular socket.sendall() can give socket error 10053 on Windows. This
1982
implementation sends no more than 64k at a time, which avoids this problem.
2052
1984
:param report_activity: Call this as bytes are read, see
2053
1985
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')
1988
for pos in xrange(0, len(bytes), chunk_size):
1989
block = bytes[pos:pos+chunk_size]
1990
if report_activity is not None:
1991
report_activity(len(block), 'write')
1992
until_no_eintr(socket.sendall, block)
2068
1995
def dereference_path(path):
2109
2036
base = dirname(bzrlib.__file__)
2110
2037
if getattr(sys, 'frozen', None): # bzr.exe
2111
2038
base = abspath(pathjoin(base, '..', '..'))
2112
f = file(pathjoin(base, resource_relpath), "rU")
2039
filename = pathjoin(base, resource_relpath)
2040
return open(filename, 'rU').read()
2118
2043
def file_kind_from_stat_mode_thunk(mode):
2119
2044
global file_kind_from_stat_mode
2143
2068
def until_no_eintr(f, *a, **kw):
2144
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2146
WARNING: you must be certain that it is safe to retry the call repeatedly
2147
if EINTR does occur. This is typically only true for low-level operations
2148
like os.read. If in any doubt, don't use this.
2150
Keep in mind that this is not a complete solution to EINTR. There is
2151
probably code in the Python standard library and other dependencies that
2152
may encounter EINTR if a signal arrives (and there is signal handler for
2153
that signal). So this function can reduce the impact for IO that bzrlib
2154
directly controls, but it is not a complete solution.
2069
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
2156
2070
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
added
removed
bzrlib/osutils.py
