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
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
25
from bzrlib.lazy_import import lazy_import
27
26
lazy_import(globals(), """
28
28
from datetime import datetime
30
30
from ntpath import (abspath as _nt_abspath,
32
32
normpath as _nt_normpath,
77
69
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
72
# On win32, O_BINARY is used to indicate the file should
90
73
# be opened in binary mode, rather than text mode.
91
74
# On other platforms, O_BINARY doesn't exist, because
92
75
# 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.
76
# OR with 0 on those platforms
95
77
O_BINARY = getattr(os, 'O_BINARY', 0)
96
O_TEXT = getattr(os, 'O_TEXT', 0)
97
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
100
def get_unicode_argv():
102
user_encoding = get_user_encoding()
103
return [a.decode(user_encoding) for a in sys.argv[1:]]
104
except UnicodeDecodeError:
105
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
109
80
def make_readonly(filename):
209
172
def fancy_rename(old, new, rename_func, unlink_func):
210
173
"""A fancy rename, when you don't have atomic rename.
212
175
:param old: The old path, to rename from
213
176
:param new: The new path, to rename to
214
177
:param rename_func: The potentially non-atomic rename function
215
: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
218
181
# sftp rename doesn't allow overwriting, so play tricks:
219
182
base = os.path.basename(new)
220
183
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))
184
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
226
185
tmp_name = pathjoin(dirname, tmp_name)
228
187
# Rename the file out of the way, but keep track if it didn't exist
929
819
return pathjoin(*p)
932
def parent_directories(filename):
933
"""Return the list of parent directories, deepest first.
935
For example, parent_directories("a/b/c") -> ["a/b", "a"].
938
parts = splitpath(dirname(filename))
940
parents.append(joinpath(parts))
945
_extension_load_failures = []
948
def failed_to_load_extension(exception):
949
"""Handle failing to load a binary extension.
951
This should be called from the ImportError block guarding the attempt to
952
import the native extension. If this function returns, the pure-Python
953
implementation should be loaded instead::
956
>>> import bzrlib._fictional_extension_pyx
957
>>> except ImportError, e:
958
>>> bzrlib.osutils.failed_to_load_extension(e)
959
>>> import bzrlib._fictional_extension_py
961
# NB: This docstring is just an example, not a doctest, because doctest
962
# currently can't cope with the use of lazy imports in this namespace --
965
# This currently doesn't report the failure at the time it occurs, because
966
# they tend to happen very early in startup when we can't check config
967
# files etc, and also we want to report all failures but not spam the user
969
from bzrlib import trace
970
exception_str = str(exception)
971
if exception_str not in _extension_load_failures:
972
trace.mutter("failed to load compiled extension: %s" % exception_str)
973
_extension_load_failures.append(exception_str)
976
def report_extension_load_failures():
977
if not _extension_load_failures:
979
from bzrlib.config import GlobalConfig
980
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
982
# the warnings framework should by default show this only once
983
from bzrlib.trace import warning
985
"bzr: warning: some compiled extensions could not be loaded; "
986
"see <https://answers.launchpad.net/bzr/+faq/703>")
987
# we no longer show the specific missing extensions here, because it makes
988
# the message too long and scary - see
989
# https://bugs.launchpad.net/bzr/+bug/430529
993
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
994
except ImportError, e:
995
failed_to_load_extension(e)
996
from bzrlib._chunks_to_lines_py import chunks_to_lines
999
822
def split_lines(s):
1000
823
"""Split s into lines, but without removing the newline characters."""
1001
# Trivially convert a fulltext into a 'chunked' representation, and let
1002
# chunks_to_lines do the heavy lifting.
1003
if isinstance(s, str):
1004
# chunks_to_lines only supports 8-bit strings
1005
return chunks_to_lines([s])
1007
return _split_lines(s)
1010
def _split_lines(s):
1011
"""Split s into lines, but without removing the newline characters.
1013
This supports Unicode or plain string objects.
1015
824
lines = s.split('\n')
1016
825
result = [line + '\n' for line in lines[:-1]]
1036
845
shutil.copyfile(src, dest)
848
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
849
# Forgiveness than Permission (EAFP) because:
850
# - root can damage a solaris file system by using unlink,
851
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
852
# EACCES, OSX: EPERM) when invoked on a directory.
1039
853
def delete_any(path):
1040
"""Delete a file, symlink or directory.
1042
Will delete even if readonly.
1045
_delete_file_or_dir(path)
1046
except (OSError, IOError), e:
1047
if e.errno in (errno.EPERM, errno.EACCES):
1048
# make writable and try again
1051
except (OSError, IOError):
1053
_delete_file_or_dir(path)
1058
def _delete_file_or_dir(path):
1059
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1060
# Forgiveness than Permission (EAFP) because:
1061
# - root can damage a solaris file system by using unlink,
1062
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1063
# EACCES, OSX: EPERM) when invoked on a directory.
854
"""Delete a file or directory."""
1064
855
if isdir(path): # Takes care of symlinks
1156
if len(head) <= len(base) and head != base:
1157
raise errors.PathNotChild(rp, base)
929
while len(head) >= len(base):
1158
930
if head == base:
1160
head, tail = split(head)
932
head, tail = os.path.split(head)
936
raise errors.PathNotChild(rp, base)
1165
return pathjoin(*reversed(s))
1170
def _cicp_canonical_relpath(base, path):
1171
"""Return the canonical path relative to base.
1173
Like relpath, but on case-insensitive-case-preserving file-systems, this
1174
will return the relpath as stored on the file-system rather than in the
1175
case specified in the input string, for all existing portions of the path.
1177
This will cause O(N) behaviour if called for every path in a tree; if you
1178
have a number of paths to convert, you should use canonical_relpaths().
1180
# TODO: it should be possible to optimize this for Windows by using the
1181
# win32 API FindFiles function to look for the specified name - but using
1182
# os.listdir() still gives us the correct, platform agnostic semantics in
1185
rel = relpath(base, path)
1186
# '.' will have been turned into ''
1190
abs_base = abspath(base)
1192
_listdir = os.listdir
1194
# use an explicit iterator so we can easily consume the rest on early exit.
1195
bit_iter = iter(rel.split('/'))
1196
for bit in bit_iter:
1199
next_entries = _listdir(current)
1200
except OSError: # enoent, eperm, etc
1201
# We can't find this in the filesystem, so just append the
1203
current = pathjoin(current, bit, *list(bit_iter))
1205
for look in next_entries:
1206
if lbit == look.lower():
1207
current = pathjoin(current, look)
1210
# got to the end, nothing matched, so we just return the
1211
# non-existing bits as they were specified (the filename may be
1212
# the target of a move, for example).
1213
current = pathjoin(current, bit, *list(bit_iter))
1215
return current[len(abs_base):].lstrip('/')
1217
# XXX - TODO - we need better detection/integration of case-insensitive
1218
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1219
# filesystems), for example, so could probably benefit from the same basic
1220
# support there. For now though, only Windows and OSX get that support, and
1221
# they get it for *all* file-systems!
1222
if sys.platform in ('win32', 'darwin'):
1223
canonical_relpath = _cicp_canonical_relpath
1225
canonical_relpath = relpath
1227
def canonical_relpaths(base, paths):
1228
"""Create an iterable to canonicalize a sequence of relative paths.
1230
The intent is for this implementation to use a cache, vastly speeding
1231
up multiple transformations in the same directory.
1233
# but for now, we haven't optimized...
1234
return [canonical_relpath(base, p) for p in paths]
1236
944
def safe_unicode(unicode_or_utf8_string):
1237
945
"""Coerce unicode_or_utf8_string into unicode.
1239
947
If it is unicode, it is returned.
1240
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1241
wrapped in a BzrBadParameterNotUnicode exception.
948
Otherwise it is decoded from utf-8. If a decoding error
949
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
950
as a BzrBadParameter exception.
1243
952
if isinstance(unicode_or_utf8_string, unicode):
1244
953
return unicode_or_utf8_string
1357
1066
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
default_terminal_width = 80
1397
"""The default terminal width for ttys.
1399
This is defined so that higher levels can share a common fallback value when
1400
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
1069
def terminal_width():
1411
"""Return terminal width.
1413
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
# If BZR_COLUMNS is set, take it, user is always right
1449
return int(os.environ['BZR_COLUMNS'])
1450
except (KeyError, ValueError):
1453
isatty = getattr(sys.stdout, 'isatty', None)
1454
if isatty is None or not isatty():
1455
# 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):
1070
"""Return estimated terminal width."""
1071
if sys.platform == 'win32':
1072
return win32utils.get_console_size()[0]
1496
1075
import struct, fcntl, termios
1497
1076
s = struct.pack('HHHH', 0, 0, 0, 0)
1498
1077
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1499
height, width = struct.unpack('HHHH', x)[0:2]
1500
except (IOError, AttributeError):
1078
width = struct.unpack('HHHH', x)[1]
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
1083
width = int(os.environ['COLUMNS'])
1519
1092
def supports_executable():
1966
1516
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):
1519
def recv_all(socket, bytes):
2003
1520
"""Receive an exact number of bytes.
2005
1522
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
1523
dependning on what's in the OS buffer. MSG_WAITALL is not available
2007
1524
on all platforms, but this should work everywhere. This will return
2008
1525
less than the requested amount if the remote end closes.
2010
1527
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))
1530
while len(b) < bytes:
1531
new = socket.recv(bytes - len(b))
2021
def send_all(sock, bytes, report_activity=None):
1538
def send_all(socket, bytes):
2022
1539
"""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.
2031
:param report_activity: Call this as bytes are read, see
2032
Transport._report_activity
1541
Regular socket.sendall() can give socket error 10053 on Windows. This
1542
implementation sends no more than 64k at a time, which avoids this problem.
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')
1545
for pos in xrange(0, len(bytes), chunk_size):
1546
socket.sendall(bytes[pos:pos+chunk_size])
2047
1549
def dereference_path(path):
2122
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.
2135
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2139
except (IOError, OSError), e:
2140
if e.errno == errno.EINTR:
2145
def re_compile_checked(re_string, flags=0, where=""):
2146
"""Return a compiled re, or raise a sensible error.
2148
This should only be used when compiling user-supplied REs.
2150
:param re_string: Text form of regular expression.
2151
:param flags: eg re.IGNORECASE
2152
:param where: Message explaining to the user the context where
2153
it occurred, eg 'log search filter'.
2155
# from https://bugs.launchpad.net/bzr/+bug/251352
2157
re_obj = re.compile(re_string, flags)
2162
where = ' in ' + where
2163
# despite the name 'error' is a type
2164
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2165
% (where, re_string, e))
2168
if sys.platform == "win32":
2171
return msvcrt.getch()
2176
fd = sys.stdin.fileno()
2177
settings = termios.tcgetattr(fd)
2180
ch = sys.stdin.read(1)
2182
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2186
if sys.platform == 'linux2':
2187
def _local_concurrency():
2189
prefix = 'processor'
2190
for line in file('/proc/cpuinfo', 'rb'):
2191
if line.startswith(prefix):
2192
concurrency = int(line[line.find(':')+1:]) + 1
2194
elif sys.platform == 'darwin':
2195
def _local_concurrency():
2196
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2197
stdout=subprocess.PIPE).communicate()[0]
2198
elif sys.platform[0:7] == 'freebsd':
2199
def _local_concurrency():
2200
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2201
stdout=subprocess.PIPE).communicate()[0]
2202
elif sys.platform == 'sunos5':
2203
def _local_concurrency():
2204
return subprocess.Popen(['psrinfo', '-p',],
2205
stdout=subprocess.PIPE).communicate()[0]
2206
elif sys.platform == "win32":
2207
def _local_concurrency():
2208
# This appears to return the number of cores.
2209
return os.environ.get('NUMBER_OF_PROCESSORS')
2211
def _local_concurrency():
2216
_cached_local_concurrency = None
2218
def local_concurrency(use_cache=True):
2219
"""Return how many processes can be run concurrently.
2221
Rely on platform specific implementations and default to 1 (one) if
2222
anything goes wrong.
2224
global _cached_local_concurrency
2226
if _cached_local_concurrency is not None and use_cache:
2227
return _cached_local_concurrency
2229
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2230
if concurrency is None:
2232
concurrency = _local_concurrency()
2233
except (OSError, IOError):
2236
concurrency = int(concurrency)
2237
except (TypeError, ValueError):
2240
_cached_concurrency = 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
