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
26
from bzrlib.lazy_import import lazy_import
26
27
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 (
52
from bzrlib.symbol_versioning import (
57
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
59
if sys.version_info < (2, 5):
60
import md5 as _mod_md5
62
import sha as _mod_sha
202
205
:param unlink_func: A way to delete the target file if the full rename
208
new = safe_unicode(new)
205
209
# sftp rename doesn't allow overwriting, so play tricks:
206
210
base = os.path.basename(new)
207
211
dirname = os.path.dirname(new)
208
# callers use different encodings for the paths so the following MUST
209
# respect that. We rely on python upcasting to unicode if new is unicode
210
# and keeping a str if not.
211
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
212
os.getpid(), rand_chars(10))
212
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(),
213
os.getpid(), rand_chars(10))
213
214
tmp_name = pathjoin(dirname, tmp_name)
215
216
# Rename the file out of the way, but keep track if it didn't exist
317
315
# /path => C:/path
318
316
path = unicode(path)
319
317
# check for absolute path
320
drive = ntpath.splitdrive(path)[0]
318
drive = _nt_splitdrive(path)[0]
321
319
if drive == '' and path[:2] not in('//','\\\\'):
322
320
cwd = os.getcwdu()
323
321
# we cannot simply os.path.join cwd and path
324
322
# because os.path.join('C:','/path') produce '/path'
325
323
# and this is incorrect
326
324
if path[:1] in ('/','\\'):
327
cwd = ntpath.splitdrive(cwd)[0]
325
cwd = _nt_splitdrive(cwd)[0]
329
327
path = cwd + '\\' + path
330
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
328
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
333
331
def _win32_realpath(path):
334
# Real ntpath.realpath doesn't have a problem with a unicode cwd
335
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
332
# Real _nt_realpath doesn't have a problem with a unicode cwd
333
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
336
def _win32_pathjoin(*args):
339
return ntpath.join(*args).replace('\\', '/')
337
return _nt_join(*args).replace('\\', '/')
342
340
def _win32_normpath(path):
343
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
341
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
346
344
def _win32_getcwd():
466
448
input_encoding = getattr(sys.stdin, 'encoding', None)
467
449
if not input_encoding:
468
450
output_encoding = get_user_encoding()
470
mutter('encoding stdout as osutils.get_user_encoding() %r',
451
mutter('encoding stdout as osutils.get_user_encoding() %r',
473
454
output_encoding = input_encoding
475
mutter('encoding stdout as sys.stdin encoding %r',
455
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
479
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
457
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
480
458
if output_encoding == 'cp0':
481
459
# invalid encoding (cp0 means 'no codepage' on Windows)
482
460
output_encoding = get_user_encoding()
484
mutter('cp0 is invalid encoding.'
461
mutter('cp0 is invalid encoding.'
485
462
' encoding stdout as osutils.get_user_encoding() %r',
1242
1218
# but for now, we haven't optimized...
1243
1219
return [canonical_relpath(base, p) for p in paths]
1246
def decode_filename(filename):
1247
"""Decode the filename using the filesystem encoding
1249
If it is unicode, it is returned.
1250
Otherwise it is decoded from the the filesystem's encoding. If decoding
1251
fails, a errors.BadFilenameEncoding exception is raised.
1253
if type(filename) is unicode:
1256
return filename.decode(_fs_enc)
1257
except UnicodeDecodeError:
1258
raise errors.BadFilenameEncoding(filename, _fs_enc)
1261
1221
def safe_unicode(unicode_or_utf8_string):
1262
1222
"""Coerce unicode_or_utf8_string into unicode.
1382
1342
normalized_filename = _inaccessible_normalized_filename
1385
def set_signal_handler(signum, handler, restart_syscall=True):
1386
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1387
on platforms that support that.
1389
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1390
automatically restart (by calling `signal.siginterrupt(signum,
1391
False)`). May be ignored if the feature is not available on this
1392
platform or Python version.
1396
siginterrupt = signal.siginterrupt
1398
# This python implementation doesn't provide signal support, hence no
1401
except AttributeError:
1402
# siginterrupt doesn't exist on this platform, or for this version
1404
siginterrupt = lambda signum, flag: None
1406
def sig_handler(*args):
1407
# Python resets the siginterrupt flag when a signal is
1408
# received. <http://bugs.python.org/issue8354>
1409
# As a workaround for some cases, set it back the way we want it.
1410
siginterrupt(signum, False)
1411
# Now run the handler function passed to set_signal_handler.
1414
sig_handler = handler
1415
old_handler = signal.signal(signum, sig_handler)
1417
siginterrupt(signum, False)
1421
1345
default_terminal_width = 80
1422
1346
"""The default terminal width for ttys.
1441
1359
- if BZR_COLUMNS is set, returns its value
1442
1360
- if there is no controlling terminal, returns None
1443
- query the OS, if the queried size has changed since the last query,
1445
1361
- if COLUMNS is set, returns its value,
1446
- if the OS has a value (even though it's never changed), return its value.
1448
1363
From there, we need to query the OS to get the size of the controlling
1451
On Unices we query the OS by:
1452
1367
- get termios.TIOCGWINSZ
1453
1368
- if an error occurs or a negative value is obtained, returns None
1455
On Windows we query the OS by:
1456
1372
- win32utils.get_console_size() decides,
1457
1373
- returns None on error (provided default value)
1459
# Note to implementors: if changing the rules for determining the width,
1460
# make sure you've considered the behaviour in these cases:
1461
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1462
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1464
# - (add more interesting cases here, if you find any)
1465
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1466
# but we don't want to register a signal handler because it is impossible
1467
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1468
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1469
# time so we can notice if the reported size has changed, which should have
1472
1376
# If BZR_COLUMNS is set, take it, user is always right
1473
# Except if they specified 0 in which case, impose no limit here
1475
width = int(os.environ['BZR_COLUMNS'])
1378
return int(os.environ['BZR_COLUMNS'])
1476
1379
except (KeyError, ValueError):
1478
if width is not None:
1484
1382
isatty = getattr(sys.stdout, 'isatty', None)
1485
if isatty is None or not isatty():
1383
if isatty is None or not isatty():
1486
1384
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1490
width, height = os_size = _terminal_size(None, None)
1491
global _first_terminal_size, _terminal_size_state
1492
if _terminal_size_state == 'no_data':
1493
_first_terminal_size = os_size
1494
_terminal_size_state = 'unchanged'
1495
elif (_terminal_size_state == 'unchanged' and
1496
_first_terminal_size != os_size):
1497
_terminal_size_state = 'changed'
1499
# If the OS claims to know how wide the terminal is, and this value has
1500
# ever changed, use that.
1501
if _terminal_size_state == 'changed':
1502
if width is not None and width > 0:
1505
# If COLUMNS is set, use it.
1387
# If COLUMNS is set, take it, the terminal knows better (even inside a
1388
# given terminal, the application can decide to set COLUMNS to a lower
1389
# value (splitted screen) or a bigger value (scroll bars))
1507
1391
return int(os.environ['COLUMNS'])
1508
1392
except (KeyError, ValueError):
1511
# Finally, use an unchanged size from the OS, if we have one.
1512
if _terminal_size_state == 'unchanged':
1513
if width is not None and width > 0:
1395
width, height = _terminal_size(None, None)
1397
# Consider invalid values as meaning no width
1516
# The width could not be determined.
1520
1403
def _win32_terminal_size(width, height):
1870
1767
real_handlers[kind](abspath, relpath)
1873
def copy_ownership_from_path(dst, src=None):
1874
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1876
If src is None, the containing directory is used as source. If chown
1877
fails, the error is ignored and a warning is printed.
1879
chown = getattr(os, 'chown', None)
1884
src = os.path.dirname(dst)
1890
chown(dst, s.st_uid, s.st_gid)
1893
'Unable to copy ownership from "%s" to "%s". '
1894
'You may want to set it manually.', src, dst)
1895
trace.log_exception_quietly()
1898
1770
def path_prefix_key(path):
1899
1771
"""Generate a prefix-order path key for path.
2004
1872
return socket.gethostname().decode(get_user_encoding())
2007
# We must not read/write any more than 64k at a time from/to a socket so we
2008
# don't risk "no buffer space available" errors on some platforms. Windows in
2009
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2011
MAX_SOCKET_CHUNK = 64 * 1024
2013
_end_of_stream_errors = [errno.ECONNRESET]
2014
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2015
_eno = getattr(errno, _eno, None)
2016
if _eno is not None:
2017
_end_of_stream_errors.append(_eno)
2021
def read_bytes_from_socket(sock, report_activity=None,
2022
max_read_size=MAX_SOCKET_CHUNK):
2023
"""Read up to max_read_size of bytes from sock and notify of progress.
2025
Translates "Connection reset by peer" into file-like EOF (return an
2026
empty string rather than raise an error), and repeats the recv if
2027
interrupted by a signal.
2031
bytes = sock.recv(max_read_size)
2032
except socket.error, e:
2034
if eno in _end_of_stream_errors:
2035
# The connection was closed by the other side. Callers expect
2036
# an empty string to signal end-of-stream.
2038
elif eno == errno.EINTR:
2039
# Retry the interrupted recv.
2043
if report_activity is not None:
2044
report_activity(len(bytes), 'read')
2048
def recv_all(socket, count):
1875
def recv_all(socket, bytes):
2049
1876
"""Receive an exact number of bytes.
2051
1878
Regular Socket.recv() may return less than the requested number of bytes,
2052
depending on what's in the OS buffer. MSG_WAITALL is not available
1879
dependning on what's in the OS buffer. MSG_WAITALL is not available
2053
1880
on all platforms, but this should work everywhere. This will return
2054
1881
less than the requested amount if the remote end closes.
2056
1883
This isn't optimized and is intended mostly for use in testing.
2059
while len(b) < count:
2060
new = read_bytes_from_socket(socket, None, count - len(b))
1886
while len(b) < bytes:
1887
new = until_no_eintr(socket.recv, bytes - len(b))
2067
def send_all(sock, bytes, report_activity=None):
1894
def send_all(socket, bytes, report_activity=None):
2068
1895
"""Send all bytes on a socket.
2070
Breaks large blocks in smaller chunks to avoid buffering limitations on
2071
some platforms, and catches EINTR which may be thrown if the send is
2072
interrupted by a signal.
2074
This is preferred to socket.sendall(), because it avoids portability bugs
2075
and provides activity reporting.
1897
Regular socket.sendall() can give socket error 10053 on Windows. This
1898
implementation sends no more than 64k at a time, which avoids this problem.
2077
1900
:param report_activity: Call this as bytes are read, see
2078
1901
Transport._report_activity
2081
byte_count = len(bytes)
2082
while sent_total < byte_count:
2084
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2085
except socket.error, e:
2086
if e.args[0] != errno.EINTR:
2090
report_activity(sent, 'write')
2093
def connect_socket(address):
2094
# Slight variation of the socket.create_connection() function (provided by
2095
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2096
# provide it for previous python versions. Also, we don't use the timeout
2097
# parameter (provided by the python implementation) so we don't implement
2099
err = socket.error('getaddrinfo returns an empty list')
2100
host, port = address
2101
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2102
af, socktype, proto, canonname, sa = res
2105
sock = socket.socket(af, socktype, proto)
2109
except socket.error, err:
2110
# 'err' is now the most recent error
2111
if sock is not None:
1904
for pos in xrange(0, len(bytes), chunk_size):
1905
block = bytes[pos:pos+chunk_size]
1906
if report_activity is not None:
1907
report_activity(len(block), 'write')
1908
until_no_eintr(socket.sendall, block)
2116
1911
def dereference_path(path):
2191
1984
def until_no_eintr(f, *a, **kw):
2192
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2194
WARNING: you must be certain that it is safe to retry the call repeatedly
2195
if EINTR does occur. This is typically only true for low-level operations
2196
like os.read. If in any doubt, don't use this.
2198
Keep in mind that this is not a complete solution to EINTR. There is
2199
probably code in the Python standard library and other dependencies that
2200
may encounter EINTR if a signal arrives (and there is signal handler for
2201
that signal). So this function can reduce the impact for IO that bzrlib
2202
directly controls, but it is not a complete solution.
1985
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
2204
1986
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2252
2032
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2255
2036
if sys.platform == 'linux2':
2256
2037
def _local_concurrency():
2258
return os.sysconf('SC_NPROCESSORS_ONLN')
2259
except (ValueError, OSError, AttributeError):
2039
prefix = 'processor'
2040
for line in file('/proc/cpuinfo', 'rb'):
2041
if line.startswith(prefix):
2042
concurrency = int(line[line.find(':')+1:]) + 1
2261
2044
elif sys.platform == 'darwin':
2262
2045
def _local_concurrency():
2263
2046
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2264
2047
stdout=subprocess.PIPE).communicate()[0]
2265
elif "bsd" in sys.platform:
2048
elif sys.platform[0:7] == 'freebsd':
2266
2049
def _local_concurrency():
2267
2050
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2268
2051
stdout=subprocess.PIPE).communicate()[0]
2328
2105
data, _ = self.encode(object, self.errors)
2329
2106
self.stream.write(data)
2331
if sys.platform == 'win32':
2332
def open_file(filename, mode='r', bufsize=-1):
2333
"""This function is used to override the ``open`` builtin.
2335
But it uses O_NOINHERIT flag so the file handle is not inherited by
2336
child processes. Deleting or renaming a closed file opened with this
2337
function is not blocking child processes.
2339
writing = 'w' in mode
2340
appending = 'a' in mode
2341
updating = '+' in mode
2342
binary = 'b' in mode
2345
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2346
# for flags for each modes.
2356
flags |= os.O_WRONLY
2357
flags |= os.O_CREAT | os.O_TRUNC
2362
flags |= os.O_WRONLY
2363
flags |= os.O_CREAT | os.O_APPEND
2368
flags |= os.O_RDONLY
2370
return os.fdopen(os.open(filename, flags), mode, bufsize)
2375
def getuser_unicode():
2376
"""Return the username as unicode.
2379
user_encoding = get_user_encoding()
2380
username = getpass.getuser().decode(user_encoding)
2381
except UnicodeDecodeError:
2382
raise errors.BzrError("Can't decode username as %s." % \
2384
except ImportError, e:
2385
if sys.platform != 'win32':
2387
if str(e) != 'No module named pwd':
2389
# https://bugs.launchpad.net/bzr/+bug/660174
2390
# getpass.getuser() is unable to return username on Windows
2391
# if there is no USERNAME environment variable set.
2392
# That could be true if bzr is running as a service,
2393
# e.g. running `bzr serve` as a service on Windows.
2394
# We should not fail with traceback in this case.
2395
username = u'UNKNOWN'
2399
def available_backup_name(base, exists):
2400
"""Find a non-existing backup file name.
2402
This will *not* create anything, this only return a 'free' entry. This
2403
should be used for checking names in a directory below a locked
2404
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2405
Leap) and generally discouraged.
2407
:param base: The base name.
2409
:param exists: A callable returning True if the path parameter exists.
2412
name = "%s.~%d~" % (base, counter)
2415
name = "%s.~%d~" % (base, counter)
2419
def set_fd_cloexec(fd):
2420
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2421
support for this is not available.
2425
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2426
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2427
except (ImportError, AttributeError):
2428
# Either the fcntl module or specific constants are not present
2432
def find_executable_on_path(name):
2433
"""Finds an executable on the PATH.
2435
On Windows, this will try to append each extension in the PATHEXT
2436
environment variable to the name, if it cannot be found with the name
2439
:param name: The base name of the executable.
2440
:return: The path to the executable found or None.
2442
path = os.environ.get('PATH')
2445
path = path.split(os.pathsep)
2446
if sys.platform == 'win32':
2447
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2448
exts = [ext.lower() for ext in exts]
2449
base, ext = os.path.splitext(name)
2451
if ext.lower() not in exts:
2459
f = os.path.join(d, name) + ext
2460
if os.access(f, os.X_OK):
2465
def _posix_is_local_pid_dead(pid):
2466
"""True if pid doesn't correspond to live process on this machine"""
2468
# Special meaning of unix kill: just check if it's there.
2471
if e.errno == errno.ESRCH:
2472
# On this machine, and really not found: as sure as we can be
2475
elif e.errno == errno.EPERM:
2476
# exists, though not ours
2479
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2480
# Don't really know.
2483
# Exists and our process: not dead.
2486
if sys.platform == "win32":
2487
is_local_pid_dead = win32utils.is_local_pid_dead
2489
is_local_pid_dead = _posix_is_local_pid_dead
2492
def fdatasync(fileno):
2493
"""Flush file contents to disk if possible.
2495
:param fileno: Integer OS file handle.
2496
:raises TransportNotPossible: If flushing to disk is not possible.
2498
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
added
removed
bzrlib/osutils.py
