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
21
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
26
from bzrlib.lazy_import import lazy_import
27
27
lazy_import(globals(), """
28
29
from datetime import datetime
30
31
from ntpath import (abspath as _nt_abspath,
32
33
normpath as _nt_normpath,
77
71
from bzrlib import symbol_versioning
80
# Cross platform wall-clock time functionality with decent resolution.
81
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
82
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
83
# synchronized with ``time.time()``, this is only meant to be used to find
84
# delta times by subtracting from another call to this function.
85
timer_func = time.time
86
if sys.platform == 'win32':
87
timer_func = time.clock
89
74
# On win32, O_BINARY is used to indicate the file should
90
75
# be opened in binary mode, rather than text mode.
91
76
# On other platforms, O_BINARY doesn't exist, because
92
77
# they always open in binary mode, so it is okay to
93
# OR with 0 on those platforms.
94
# O_NOINHERIT and O_TEXT exists only on win32 too.
78
# OR with 0 on those platforms
95
79
O_BINARY = getattr(os, 'O_BINARY', 0)
96
O_TEXT = getattr(os, 'O_TEXT', 0)
97
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
100
82
def get_unicode_argv():
212
192
:param old: The old path, to rename from
213
193
:param new: The new path, to rename to
214
194
:param rename_func: The potentially non-atomic rename function
215
:param unlink_func: A way to delete the target file if the full rename
195
:param unlink_func: A way to delete the target file if the full rename succeeds
218
198
# sftp rename doesn't allow overwriting, so play tricks:
219
199
base = os.path.basename(new)
220
200
dirname = os.path.dirname(new)
221
# callers use different encodings for the paths so the following MUST
222
# respect that. We rely on python upcasting to unicode if new is unicode
223
# and keeping a str if not.
224
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
225
os.getpid(), rand_chars(10))
201
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
226
202
tmp_name = pathjoin(dirname, tmp_name)
228
204
# Rename the file out of the way, but keep track if it didn't exist
1357
1330
normalized_filename = _inaccessible_normalized_filename
1360
def set_signal_handler(signum, handler, restart_syscall=True):
1361
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1362
on platforms that support that.
1364
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1365
automatically restart (by calling `signal.siginterrupt(signum,
1366
False)`). May be ignored if the feature is not available on this
1367
platform or Python version.
1371
siginterrupt = signal.siginterrupt
1373
# This python implementation doesn't provide signal support, hence no
1376
except AttributeError:
1377
# siginterrupt doesn't exist on this platform, or for this version
1379
siginterrupt = lambda signum, flag: None
1381
def sig_handler(*args):
1382
# Python resets the siginterrupt flag when a signal is
1383
# received. <http://bugs.python.org/issue8354>
1384
# As a workaround for some cases, set it back the way we want it.
1385
siginterrupt(signum, False)
1386
# Now run the handler function passed to set_signal_handler.
1389
sig_handler = handler
1390
old_handler = signal.signal(signum, sig_handler)
1392
siginterrupt(signum, False)
1396
1333
default_terminal_width = 80
1397
1334
"""The default terminal width for ttys.
1400
1337
terminal_width() returns None.
1403
# Keep some state so that terminal_width can detect if _terminal_size has
1404
# returned a different size since the process started. See docstring and
1405
# comments of terminal_width for details.
1406
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1407
_terminal_size_state = 'no_data'
1408
_first_terminal_size = None
1410
1341
def terminal_width():
1411
1342
"""Return terminal width.
1413
1344
None is returned if the width can't established precisely.
1416
- if BZR_COLUMNS is set, returns its value
1417
- if there is no controlling terminal, returns None
1418
- query the OS, if the queried size has changed since the last query,
1420
- if COLUMNS is set, returns its value,
1421
- if the OS has a value (even though it's never changed), return its value.
1423
From there, we need to query the OS to get the size of the controlling
1426
On Unices we query the OS by:
1427
- get termios.TIOCGWINSZ
1428
- if an error occurs or a negative value is obtained, returns None
1430
On Windows we query the OS by:
1431
- win32utils.get_console_size() decides,
1432
- returns None on error (provided default value)
1434
# Note to implementors: if changing the rules for determining the width,
1435
# make sure you've considered the behaviour in these cases:
1436
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1437
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1439
# - (add more interesting cases here, if you find any)
1440
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1441
# but we don't want to register a signal handler because it is impossible
1442
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1443
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1444
# time so we can notice if the reported size has changed, which should have
1447
1347
# If BZR_COLUMNS is set, take it, user is always right
1453
1353
isatty = getattr(sys.stdout, 'isatty', None)
1454
if isatty is None or not isatty():
1354
if isatty is None or not isatty():
1455
1355
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1459
width, height = os_size = _terminal_size(None, None)
1460
global _first_terminal_size, _terminal_size_state
1461
if _terminal_size_state == 'no_data':
1462
_first_terminal_size = os_size
1463
_terminal_size_state = 'unchanged'
1464
elif (_terminal_size_state == 'unchanged' and
1465
_first_terminal_size != os_size):
1466
_terminal_size_state = 'changed'
1468
# If the OS claims to know how wide the terminal is, and this value has
1469
# ever changed, use that.
1470
if _terminal_size_state == 'changed':
1471
if width is not None and width > 0:
1474
# If COLUMNS is set, use it.
1476
return int(os.environ['COLUMNS'])
1477
except (KeyError, ValueError):
1480
# Finally, use an unchanged size from the OS, if we have one.
1481
if _terminal_size_state == 'unchanged':
1482
if width is not None and width > 0:
1485
# The width could not be determined.
1489
def _win32_terminal_size(width, height):
1490
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1491
return width, height
1494
def _ioctl_terminal_size(width, height):
1358
if sys.platform == 'win32':
1359
return win32utils.get_console_size(defaultx=None)[0]
1496
1362
import struct, fcntl, termios
1497
1363
s = struct.pack('HHHH', 0, 0, 0, 0)
1498
1364
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1499
height, width = struct.unpack('HHHH', x)[0:2]
1365
width = struct.unpack('HHHH', x)[1]
1500
1366
except (IOError, AttributeError):
1502
return width, height
1504
_terminal_size = None
1505
"""Returns the terminal size as (width, height).
1507
:param width: Default value for width.
1508
:param height: Default value for height.
1510
This is defined specifically for each OS and query the size of the controlling
1511
terminal. If any error occurs, the provided default values should be returned.
1513
if sys.platform == 'win32':
1514
_terminal_size = _win32_terminal_size
1516
_terminal_size = _ioctl_terminal_size
1367
# If COLUMNS is set, take it
1369
return int(os.environ['COLUMNS'])
1370
except (KeyError, ValueError):
1374
# Consider invalid values as meaning no width
1519
1380
def supports_executable():
1839
1700
real_handlers[kind](abspath, relpath)
1842
def copy_ownership_from_path(dst, src=None):
1843
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1845
If src is None, the containing directory is used as source. If chown
1846
fails, the error is ignored and a warning is printed.
1848
chown = getattr(os, 'chown', None)
1853
src = os.path.dirname(dst)
1859
chown(dst, s.st_uid, s.st_gid)
1861
trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1864
1703
def path_prefix_key(path):
1865
1704
"""Generate a prefix-order path key for path.
1966
1805
return socket.gethostname().decode(get_user_encoding())
1969
# We must not read/write any more than 64k at a time from/to a socket so we
1970
# don't risk "no buffer space available" errors on some platforms. Windows in
1971
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1973
MAX_SOCKET_CHUNK = 64 * 1024
1975
def read_bytes_from_socket(sock, report_activity=None,
1976
max_read_size=MAX_SOCKET_CHUNK):
1977
"""Read up to max_read_size of bytes from sock and notify of progress.
1979
Translates "Connection reset by peer" into file-like EOF (return an
1980
empty string rather than raise an error), and repeats the recv if
1981
interrupted by a signal.
1985
bytes = sock.recv(max_read_size)
1986
except socket.error, e:
1988
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1989
# The connection was closed by the other side. Callers expect
1990
# an empty string to signal end-of-stream.
1992
elif eno == errno.EINTR:
1993
# Retry the interrupted recv.
1997
if report_activity is not None:
1998
report_activity(len(bytes), 'read')
2002
def recv_all(socket, count):
1808
def recv_all(socket, bytes):
2003
1809
"""Receive an exact number of bytes.
2005
1811
Regular Socket.recv() may return less than the requested number of bytes,
2006
depending on what's in the OS buffer. MSG_WAITALL is not available
1812
dependning on what's in the OS buffer. MSG_WAITALL is not available
2007
1813
on all platforms, but this should work everywhere. This will return
2008
1814
less than the requested amount if the remote end closes.
2010
1816
This isn't optimized and is intended mostly for use in testing.
2013
while len(b) < count:
2014
new = read_bytes_from_socket(socket, None, count - len(b))
1819
while len(b) < bytes:
1820
new = until_no_eintr(socket.recv, bytes - len(b))
2021
def send_all(sock, bytes, report_activity=None):
1827
def send_all(socket, bytes, report_activity=None):
2022
1828
"""Send all bytes on a socket.
2024
Breaks large blocks in smaller chunks to avoid buffering limitations on
2025
some platforms, and catches EINTR which may be thrown if the send is
2026
interrupted by a signal.
2028
This is preferred to socket.sendall(), because it avoids portability bugs
2029
and provides activity reporting.
1830
Regular socket.sendall() can give socket error 10053 on Windows. This
1831
implementation sends no more than 64k at a time, which avoids this problem.
2031
1833
:param report_activity: Call this as bytes are read, see
2032
1834
Transport._report_activity
2035
byte_count = len(bytes)
2036
while sent_total < byte_count:
2038
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2039
except socket.error, e:
2040
if e.args[0] != errno.EINTR:
2044
report_activity(sent, 'write')
1837
for pos in xrange(0, len(bytes), chunk_size):
1838
block = bytes[pos:pos+chunk_size]
1839
if report_activity is not None:
1840
report_activity(len(block), 'write')
1841
until_no_eintr(socket.sendall, block)
2047
1844
def dereference_path(path):
2088
1885
base = dirname(bzrlib.__file__)
2089
1886
if getattr(sys, 'frozen', None): # bzr.exe
2090
1887
base = abspath(pathjoin(base, '..', '..'))
2091
f = file(pathjoin(base, resource_relpath), "rU")
1888
filename = pathjoin(base, resource_relpath)
1889
return open(filename, 'rU').read()
2097
1892
def file_kind_from_stat_mode_thunk(mode):
2098
1893
global file_kind_from_stat_mode
2122
1917
def until_no_eintr(f, *a, **kw):
2123
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2125
WARNING: you must be certain that it is safe to retry the call repeatedly
2126
if EINTR does occur. This is typically only true for low-level operations
2127
like os.read. If in any doubt, don't use this.
2129
Keep in mind that this is not a complete solution to EINTR. There is
2130
probably code in the Python standard library and other dependencies that
2131
may encounter EINTR if a signal arrives (and there is signal handler for
2132
that signal). So this function can reduce the impact for IO that bzrlib
2133
directly controls, but it is not a complete solution.
1918
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
2135
1919
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2240
2023
_cached_concurrency = concurrency
2241
2024
return concurrency
2244
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2245
"""A stream writer that doesn't decode str arguments."""
2247
def __init__(self, encode, stream, errors='strict'):
2248
codecs.StreamWriter.__init__(self, stream, errors)
2249
self.encode = encode
2251
def write(self, object):
2252
if type(object) is str:
2253
self.stream.write(object)
2255
data, _ = self.encode(object, self.errors)
2256
self.stream.write(data)
2258
if sys.platform == 'win32':
2259
def open_file(filename, mode='r', bufsize=-1):
2260
"""This function is used to override the ``open`` builtin.
2262
But it uses O_NOINHERIT flag so the file handle is not inherited by
2263
child processes. Deleting or renaming a closed file opened with this
2264
function is not blocking child processes.
2266
writing = 'w' in mode
2267
appending = 'a' in mode
2268
updating = '+' in mode
2269
binary = 'b' in mode
2272
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2273
# for flags for each modes.
2283
flags |= os.O_WRONLY
2284
flags |= os.O_CREAT | os.O_TRUNC
2289
flags |= os.O_WRONLY
2290
flags |= os.O_CREAT | os.O_APPEND
2295
flags |= os.O_RDONLY
2297
return os.fdopen(os.open(filename, flags), mode, bufsize)
2302
def getuser_unicode():
2303
"""Return the username as unicode.
2306
user_encoding = get_user_encoding()
2307
username = getpass.getuser().decode(user_encoding)
2308
except UnicodeDecodeError:
2309
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
