13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
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)
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
28
from datetime import datetime
29
30
from ntpath import (abspath as _nt_abspath,
76
69
from bzrlib import symbol_versioning
79
# Cross platform wall-clock time functionality with decent resolution.
80
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
81
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
82
# synchronized with ``time.time()``, this is only meant to be used to find
83
# delta times by subtracting from another call to this function.
84
timer_func = time.time
85
if sys.platform == 'win32':
86
timer_func = time.clock
88
72
# On win32, O_BINARY is used to indicate the file should
89
73
# be opened in binary mode, rather than text mode.
90
74
# On other platforms, O_BINARY doesn't exist, because
91
75
# they always open in binary mode, so it is okay to
92
# OR with 0 on those platforms.
93
# O_NOINHERIT and O_TEXT exists only on win32 too.
76
# OR with 0 on those platforms
94
77
O_BINARY = getattr(os, 'O_BINARY', 0)
95
O_TEXT = getattr(os, 'O_TEXT', 0)
96
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
99
def get_unicode_argv():
101
user_encoding = get_user_encoding()
102
return [a.decode(user_encoding) for a in sys.argv[1:]]
103
except UnicodeDecodeError:
104
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
108
80
def make_readonly(filename):
208
172
def fancy_rename(old, new, rename_func, unlink_func):
209
173
"""A fancy rename, when you don't have atomic rename.
211
175
:param old: The old path, to rename from
212
176
:param new: The new path, to rename to
213
177
:param rename_func: The potentially non-atomic rename function
214
:param unlink_func: A way to delete the target file if the full rename
178
:param unlink_func: A way to delete the target file if the full rename succeeds
217
181
# sftp rename doesn't allow overwriting, so play tricks:
218
182
base = os.path.basename(new)
219
183
dirname = os.path.dirname(new)
220
# callers use different encodings for the paths so the following MUST
221
# respect that. We rely on python upcasting to unicode if new is unicode
222
# and keeping a str if not.
223
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
224
os.getpid(), rand_chars(10))
184
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
225
185
tmp_name = pathjoin(dirname, tmp_name)
227
187
# Rename the file out of the way, but keep track if it didn't exist
360
313
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
363
def _add_rename_error_details(e, old, new):
364
new_e = OSError(e.errno, "failed to rename %s to %s: %s"
365
% (old, new, e.strerror))
367
new_e.to_filename = new
371
316
def _win32_rename(old, new):
372
317
"""We expect to be able to atomically replace 'new' with old.
374
319
On win32, if new exists, it must be moved out of the way first,
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
323
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
324
except OSError, e:
380
325
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
# If we try to rename a non-existant file onto cwd, we get
382
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
326
# If we try to rename a non-existant file onto cwd, we get
327
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
383
328
# if the old path doesn't exist, sometimes we get EACCES
384
329
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
389
def _wrapped_rename(old, new):
390
"""Rename a file or directory"""
393
except (IOError, OSError), e:
394
# this is eventually called by all rename-like functions, so should
396
raise _add_rename_error_details(e, old, new)
399
334
def _mac_getcwd():
400
335
return unicodedata.normalize('NFC', os.getcwdu())
757
658
date_str = time.strftime(date_fmt, tt)
758
659
return date_str + offset_str
761
# Cache of formatted offset strings
765
def format_date_with_offset_in_original_timezone(t, offset=0,
766
_cache=_offset_cache):
767
"""Return a formatted date string in the original timezone.
769
This routine may be faster then format_date.
771
:param t: Seconds since the epoch.
772
:param offset: Timezone offset in seconds east of utc.
776
tt = time.gmtime(t + offset)
777
date_fmt = _default_format_by_weekday_num[tt[6]]
778
date_str = time.strftime(date_fmt, tt)
779
offset_str = _cache.get(offset, None)
780
if offset_str is None:
781
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
782
_cache[offset] = offset_str
783
return date_str + offset_str
786
661
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
787
662
show_offset=True):
788
663
"""Return an unicode date string formatted according to the current locale.
946
820
return pathjoin(*p)
949
def parent_directories(filename):
950
"""Return the list of parent directories, deepest first.
952
For example, parent_directories("a/b/c") -> ["a/b", "a"].
955
parts = splitpath(dirname(filename))
957
parents.append(joinpath(parts))
962
_extension_load_failures = []
965
def failed_to_load_extension(exception):
966
"""Handle failing to load a binary extension.
968
This should be called from the ImportError block guarding the attempt to
969
import the native extension. If this function returns, the pure-Python
970
implementation should be loaded instead::
973
>>> import bzrlib._fictional_extension_pyx
974
>>> except ImportError, e:
975
>>> bzrlib.osutils.failed_to_load_extension(e)
976
>>> import bzrlib._fictional_extension_py
978
# NB: This docstring is just an example, not a doctest, because doctest
979
# currently can't cope with the use of lazy imports in this namespace --
982
# This currently doesn't report the failure at the time it occurs, because
983
# they tend to happen very early in startup when we can't check config
984
# files etc, and also we want to report all failures but not spam the user
986
from bzrlib import trace
987
exception_str = str(exception)
988
if exception_str not in _extension_load_failures:
989
trace.mutter("failed to load compiled extension: %s" % exception_str)
990
_extension_load_failures.append(exception_str)
993
def report_extension_load_failures():
994
if not _extension_load_failures:
996
from bzrlib.config import GlobalConfig
997
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
999
# the warnings framework should by default show this only once
1000
from bzrlib.trace import warning
1002
"bzr: warning: some compiled extensions could not be loaded; "
1003
"see <https://answers.launchpad.net/bzr/+faq/703>")
1004
# we no longer show the specific missing extensions here, because it makes
1005
# the message too long and scary - see
1006
# https://bugs.launchpad.net/bzr/+bug/430529
1010
824
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
except ImportError, e:
1012
failed_to_load_extension(e)
1013
826
from bzrlib._chunks_to_lines_py import chunks_to_lines
1053
866
shutil.copyfile(src, dest)
869
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
870
# Forgiveness than Permission (EAFP) because:
871
# - root can damage a solaris file system by using unlink,
872
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
873
# EACCES, OSX: EPERM) when invoked on a directory.
1056
874
def delete_any(path):
1057
"""Delete a file, symlink or directory.
1059
Will delete even if readonly.
1062
_delete_file_or_dir(path)
1063
except (OSError, IOError), e:
1064
if e.errno in (errno.EPERM, errno.EACCES):
1065
# make writable and try again
1068
except (OSError, IOError):
1070
_delete_file_or_dir(path)
1075
def _delete_file_or_dir(path):
1076
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1077
# Forgiveness than Permission (EAFP) because:
1078
# - root can damage a solaris file system by using unlink,
1079
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1080
# EACCES, OSX: EPERM) when invoked on a directory.
875
"""Delete a file or directory."""
1081
876
if isdir(path): # Takes care of symlinks
1229
1000
# the target of a move, for example).
1230
1001
current = pathjoin(current, bit, *list(bit_iter))
1232
return current[len(abs_base):].lstrip('/')
1003
return current[len(abs_base)+1:]
1234
1005
# XXX - TODO - we need better detection/integration of case-insensitive
1235
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1236
# filesystems), for example, so could probably benefit from the same basic
1237
# support there. For now though, only Windows and OSX get that support, and
1238
# they get it for *all* file-systems!
1239
if sys.platform in ('win32', 'darwin'):
1006
# file-systems; Linux often sees FAT32 devices, for example, so could
1007
# probably benefit from the same basic support there. For now though, only
1008
# Windows gets that support, and it gets it for *all* file-systems!
1009
if sys.platform == "win32":
1240
1010
canonical_relpath = _cicp_canonical_relpath
1242
1012
canonical_relpath = relpath
1374
1145
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)
1413
default_terminal_width = 80
1414
"""The default terminal width for ttys.
1416
This is defined so that higher levels can share a common fallback value when
1417
terminal_width() returns None.
1421
1148
def terminal_width():
1422
"""Return terminal width.
1424
None is returned if the width can't established precisely.
1427
- if BZR_COLUMNS is set, returns its value
1428
- if there is no controlling terminal, returns None
1429
- if COLUMNS is set, returns its value,
1431
From there, we need to query the OS to get the size of the controlling
1435
- get termios.TIOCGWINSZ
1436
- if an error occurs or a negative value is obtained, returns None
1440
- win32utils.get_console_size() decides,
1441
- returns None on error (provided default value)
1444
# If BZR_COLUMNS is set, take it, user is always right
1446
return int(os.environ['BZR_COLUMNS'])
1447
except (KeyError, ValueError):
1450
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1455
# If COLUMNS is set, take it, the terminal knows better (even inside a
1456
# given terminal, the application can decide to set COLUMNS to a lower
1457
# value (splitted screen) or a bigger value (scroll bars))
1459
return int(os.environ['COLUMNS'])
1460
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1471
def _win32_terminal_size(width, height):
1472
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1473
return width, height
1476
def _ioctl_terminal_size(width, height):
1149
"""Return estimated terminal width."""
1150
if sys.platform == 'win32':
1151
return win32utils.get_console_size()[0]
1478
1154
import struct, fcntl, termios
1479
1155
s = struct.pack('HHHH', 0, 0, 0, 0)
1480
1156
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1481
height, width = struct.unpack('HHHH', x)[0:2]
1482
except (IOError, AttributeError):
1157
width = struct.unpack('HHHH', x)[1]
1484
return width, height
1486
_terminal_size = None
1487
"""Returns the terminal size as (width, height).
1489
:param width: Default value for width.
1490
:param height: Default value for height.
1492
This is defined specifically for each OS and query the size of the controlling
1493
terminal. If any error occurs, the provided default values should be returned.
1495
if sys.platform == 'win32':
1496
_terminal_size = _win32_terminal_size
1498
_terminal_size = _ioctl_terminal_size
1501
def _terminal_size_changed(signum, frame):
1502
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
width, height = _terminal_size(None, None)
1504
if width is not None:
1505
os.environ['COLUMNS'] = str(width)
1508
_registered_sigwinch = False
1509
def watch_sigwinch():
1510
"""Register for SIGWINCH, once and only once.
1512
Do nothing if the signal module is not available.
1514
global _registered_sigwinch
1515
if not _registered_sigwinch:
1518
if getattr(signal, "SIGWINCH", None) is not None:
1519
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
# python doesn't provide signal support, nothing we can do about it
1162
width = int(os.environ['COLUMNS'])
1523
_registered_sigwinch = True
1526
1171
def supports_executable():
1604
1249
def walkdirs(top, prefix=""):
1605
1250
"""Yield data about all the directories in a tree.
1607
1252
This yields all the data about the contents of a directory at a time.
1608
1253
After each directory has been yielded, if the caller has mutated the list
1609
1254
to exclude some directories, they are then not descended into.
1611
1256
The data yielded is of the form:
1612
1257
((directory-relpath, directory-path-from-top),
1613
1258
[(relpath, basename, kind, lstat, path-from-top), ...]),
1614
1259
- directory-relpath is the relative path of the directory being returned
1615
1260
with respect to top. prefix is prepended to this.
1616
- directory-path-from-root is the path including top for this directory.
1261
- directory-path-from-root is the path including top for this directory.
1617
1262
It is suitable for use with os functions.
1618
1263
- relpath is the relative path within the subtree being walked.
1619
1264
- basename is the basename of the path
1621
1266
present within the tree - but it may be recorded as versioned. See
1622
1267
versioned_kind.
1623
1268
- lstat is the stat data *if* the file was statted.
1624
- planned, not implemented:
1269
- planned, not implemented:
1625
1270
path_from_tree_root is the path from the root of the tree.
1627
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1272
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1628
1273
allows one to walk a subtree but get paths that are relative to a tree
1629
1274
rooted higher up.
1630
1275
:return: an iterator over the dirs.
1632
1277
#TODO there is a bit of a smell where the results of the directory-
1633
# summary in this, and the path from the root, may not agree
1278
# summary in this, and the path from the root, may not agree
1634
1279
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1635
1280
# potentially confusing output. We should make this more robust - but
1636
1281
# not at a speed cost. RBC 20060731
1720
1365
# for win98 anyway.
1722
1367
from bzrlib._walkdirs_win32 import Win32ReadDir
1369
_selected_dir_reader = UnicodeDirReader()
1723
1371
_selected_dir_reader = Win32ReadDir()
1726
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1372
elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
1373
# ANSI_X3.4-1968 is a form of ASCII
1374
_selected_dir_reader = UnicodeDirReader()
1729
1377
from bzrlib._readdir_pyx import UTF8DirReader
1379
# No optimised code path
1380
_selected_dir_reader = UnicodeDirReader()
1730
1382
_selected_dir_reader = UTF8DirReader()
1731
except ImportError, e:
1732
failed_to_load_extension(e)
1735
if _selected_dir_reader is None:
1736
# Fallback to the python version
1737
_selected_dir_reader = UnicodeDirReader()
1739
1383
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1740
1384
# But we don't actually uses 1-3 in pending, so set them to None
1741
1385
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1973
1595
return socket.gethostname().decode(get_user_encoding())
1976
# We must not read/write any more than 64k at a time from/to a socket so we
1977
# don't risk "no buffer space available" errors on some platforms. Windows in
1978
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1980
MAX_SOCKET_CHUNK = 64 * 1024
1982
def read_bytes_from_socket(sock, report_activity=None,
1983
max_read_size=MAX_SOCKET_CHUNK):
1984
"""Read up to max_read_size of bytes from sock and notify of progress.
1986
Translates "Connection reset by peer" into file-like EOF (return an
1987
empty string rather than raise an error), and repeats the recv if
1988
interrupted by a signal.
1992
bytes = sock.recv(max_read_size)
1993
except socket.error, e:
1995
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1996
# The connection was closed by the other side. Callers expect
1997
# an empty string to signal end-of-stream.
1999
elif eno == errno.EINTR:
2000
# Retry the interrupted recv.
2004
if report_activity is not None:
2005
report_activity(len(bytes), 'read')
2009
def recv_all(socket, count):
1598
def recv_all(socket, bytes):
2010
1599
"""Receive an exact number of bytes.
2012
1601
Regular Socket.recv() may return less than the requested number of bytes,
2013
depending on what's in the OS buffer. MSG_WAITALL is not available
1602
dependning on what's in the OS buffer. MSG_WAITALL is not available
2014
1603
on all platforms, but this should work everywhere. This will return
2015
1604
less than the requested amount if the remote end closes.
2017
1606
This isn't optimized and is intended mostly for use in testing.
2020
while len(b) < count:
2021
new = read_bytes_from_socket(socket, None, count - len(b))
1609
while len(b) < bytes:
1610
new = until_no_eintr(socket.recv, bytes - len(b))
2028
def send_all(sock, bytes, report_activity=None):
1617
def send_all(socket, bytes):
2029
1618
"""Send all bytes on a socket.
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
some platforms, and catches EINTR which may be thrown if the send is
2033
interrupted by a signal.
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2036
and provides activity reporting.
2038
:param report_activity: Call this as bytes are read, see
2039
Transport._report_activity
1620
Regular socket.sendall() can give socket error 10053 on Windows. This
1621
implementation sends no more than 64k at a time, which avoids this problem.
2042
byte_count = len(bytes)
2043
while sent_total < byte_count:
2045
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
except socket.error, e:
2047
if e.args[0] != errno.EINTR:
2051
report_activity(sent, 'write')
1624
for pos in xrange(0, len(bytes), chunk_size):
1625
until_no_eintr(socket.sendall, bytes[pos:pos+chunk_size])
2054
1628
def dereference_path(path):
2187
1725
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2191
if sys.platform == 'linux2':
2192
def _local_concurrency():
2194
prefix = 'processor'
2195
for line in file('/proc/cpuinfo', 'rb'):
2196
if line.startswith(prefix):
2197
concurrency = int(line[line.find(':')+1:]) + 1
2199
elif sys.platform == 'darwin':
2200
def _local_concurrency():
2201
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
stdout=subprocess.PIPE).communicate()[0]
2203
elif sys.platform[0:7] == 'freebsd':
2204
def _local_concurrency():
2205
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
stdout=subprocess.PIPE).communicate()[0]
2207
elif sys.platform == 'sunos5':
2208
def _local_concurrency():
2209
return subprocess.Popen(['psrinfo', '-p',],
2210
stdout=subprocess.PIPE).communicate()[0]
2211
elif sys.platform == "win32":
2212
def _local_concurrency():
2213
# This appears to return the number of cores.
2214
return os.environ.get('NUMBER_OF_PROCESSORS')
2216
def _local_concurrency():
2221
_cached_local_concurrency = None
2223
def local_concurrency(use_cache=True):
2224
"""Return how many processes can be run concurrently.
2226
Rely on platform specific implementations and default to 1 (one) if
2227
anything goes wrong.
2229
global _cached_local_concurrency
2231
if _cached_local_concurrency is not None and use_cache:
2232
return _cached_local_concurrency
2234
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
if concurrency is None:
2237
concurrency = _local_concurrency()
2238
except (OSError, IOError):
2241
concurrency = int(concurrency)
2242
except (TypeError, ValueError):
2245
_cached_concurrency = concurrency
2249
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2250
"""A stream writer that doesn't decode str arguments."""
2252
def __init__(self, encode, stream, errors='strict'):
2253
codecs.StreamWriter.__init__(self, stream, errors)
2254
self.encode = encode
2256
def write(self, object):
2257
if type(object) is str:
2258
self.stream.write(object)
2260
data, _ = self.encode(object, self.errors)
2261
self.stream.write(data)
2263
if sys.platform == 'win32':
2264
def open_file(filename, mode='r', bufsize=-1):
2265
"""This function is used to override the ``open`` builtin.
2267
But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
child processes. Deleting or renaming a closed file opened with this
2269
function is not blocking child processes.
2271
writing = 'w' in mode
2272
appending = 'a' in mode
2273
updating = '+' in mode
2274
binary = 'b' in mode
2277
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2278
# for flags for each modes.
2288
flags |= os.O_WRONLY
2289
flags |= os.O_CREAT | os.O_TRUNC
2294
flags |= os.O_WRONLY
2295
flags |= os.O_CREAT | os.O_APPEND
2300
flags |= os.O_RDONLY
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
added
removed
bzrlib/osutils.py
