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
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
29
from ntpath import (abspath as _nt_abspath,
31
normpath as _nt_normpath,
32
realpath as _nt_realpath,
33
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
43
from tempfile import (
43
48
from bzrlib import (
298
303
running python.exe under cmd.exe return capital C:\\
299
304
running win32 python inside a cygwin shell returns lowercase c:\\
301
drive, path = ntpath.splitdrive(path)
306
drive, path = _nt_splitdrive(path)
302
307
return drive.upper() + path
305
310
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('\\', '/'))
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
310
315
def _win98_abspath(path):
321
326
# /path => C:/path
322
327
path = unicode(path)
323
328
# check for absolute path
324
drive = ntpath.splitdrive(path)[0]
329
drive = _nt_splitdrive(path)[0]
325
330
if drive == '' and path[:2] not in('//','\\\\'):
326
331
cwd = os.getcwdu()
327
332
# we cannot simply os.path.join cwd and path
328
333
# because os.path.join('C:','/path') produce '/path'
329
334
# and this is incorrect
330
335
if path[:1] in ('/','\\'):
331
cwd = ntpath.splitdrive(cwd)[0]
336
cwd = _nt_splitdrive(cwd)[0]
333
338
path = cwd + '\\' + path
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
337
342
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('\\', '/'))
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
342
347
def _win32_pathjoin(*args):
343
return ntpath.join(*args).replace('\\', '/')
348
return _nt_join(*args).replace('\\', '/')
346
351
def _win32_normpath(path):
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
350
355
def _win32_getcwd():
355
360
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
358
371
def _win32_rename(old, new):
359
372
"""We expect to be able to atomically replace 'new' with old.
362
375
and then deleted.
365
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
366
379
except OSError, e:
367
380
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
368
381
# If we try to rename a non-existant file onto cwd, we get
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)
376
399
def _mac_getcwd():
377
400
return unicodedata.normalize('NFC', os.getcwdu())
383
406
realpath = _posix_realpath
384
407
pathjoin = os.path.join
385
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
386
410
getcwd = os.getcwdu
388
411
dirname = os.path.dirname
389
412
basename = os.path.basename
390
413
split = os.path.split
391
414
splitext = os.path.splitext
392
# These were already lazily imported into local scope
415
# These were already imported into local scope
393
416
# mkdtemp = tempfile.mkdtemp
394
417
# rmtree = shutil.rmtree
448
471
On my standard US Windows XP, the preferred encoding is
449
472
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
453
474
from bzrlib.trace import mutter
454
475
output_encoding = getattr(sys.stdout, 'encoding', None)
456
477
input_encoding = getattr(sys.stdin, 'encoding', None)
457
478
if not input_encoding:
458
479
output_encoding = get_user_encoding()
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
463
483
output_encoding = input_encoding
465
mutter('encoding stdout as sys.stdin encoding %r',
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
487
if output_encoding == 'cp0':
471
488
# invalid encoding (cp0 means 'no codepage' on Windows)
472
489
output_encoding = get_user_encoding()
474
mutter('cp0 is invalid encoding.'
490
mutter('cp0 is invalid encoding.'
475
491
' encoding stdout as osutils.get_user_encoding() %r',
512
528
"""True if f is a regular file."""
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
530
return S_ISREG(os.lstat(f)[ST_MODE])
519
535
"""True if f is a symlink."""
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
537
return S_ISLNK(os.lstat(f)[ST_MODE])
933
949
def parent_directories(filename):
934
950
"""Return the list of parent directories, deepest first.
936
952
For example, parent_directories("a/b/c") -> ["a/b", "a"].
962
978
# NB: This docstring is just an example, not a doctest, because doctest
963
979
# currently can't cope with the use of lazy imports in this namespace --
966
982
# This currently doesn't report the failure at the time it occurs, because
967
983
# they tend to happen very early in startup when we can't check config
968
984
# files etc, and also we want to report all failures but not spam the user
969
985
# with 10 warnings.
986
from bzrlib import trace
970
987
exception_str = str(exception)
971
988
if exception_str not in _extension_load_failures:
972
989
trace.mutter("failed to load compiled extension: %s" % exception_str)
1233
1250
# but for now, we haven't optimized...
1234
1251
return [canonical_relpath(base, p) for p in paths]
1237
def decode_filename(filename):
1238
"""Decode the filename using the filesystem encoding
1240
If it is unicode, it is returned.
1241
Otherwise it is decoded from the the filesystem's encoding. If decoding
1242
fails, a errors.BadFilenameEncoding exception is raised.
1244
if type(filename) is unicode:
1247
return filename.decode(_fs_enc)
1248
except UnicodeDecodeError:
1249
raise errors.BadFilenameEncoding(filename, _fs_enc)
1252
1253
def safe_unicode(unicode_or_utf8_string):
1253
1254
"""Coerce unicode_or_utf8_string into unicode.
1337
1338
def normalizes_filenames():
1338
1339
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1342
1343
return _platform_normalizes_filenames
1348
1349
On platforms where the system normalizes filenames (Mac OSX),
1349
1350
you can access a file by any path which will normalize correctly.
1350
1351
On platforms where the system does not normalize filenames
1351
(everything else), you have to access a file by its exact path.
1352
(Windows, Linux), you have to access a file by its exact path.
1353
1354
Internally, bzr only supports NFC normalization, since that is
1354
1355
the standard for XML documents.
1416
1417
terminal_width() returns None.
1419
# Keep some state so that terminal_width can detect if _terminal_size has
1420
# returned a different size since the process started. See docstring and
1421
# comments of terminal_width for details.
1422
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1423
_terminal_size_state = 'no_data'
1424
_first_terminal_size = None
1426
1421
def terminal_width():
1427
1422
"""Return terminal width.
1432
1427
- if BZR_COLUMNS is set, returns its value
1433
1428
- if there is no controlling terminal, returns None
1434
- query the OS, if the queried size has changed since the last query,
1436
1429
- if COLUMNS is set, returns its value,
1437
- if the OS has a value (even though it's never changed), return its value.
1439
1431
From there, we need to query the OS to get the size of the controlling
1442
On Unices we query the OS by:
1443
1435
- get termios.TIOCGWINSZ
1444
1436
- if an error occurs or a negative value is obtained, returns None
1446
On Windows we query the OS by:
1447
1440
- win32utils.get_console_size() decides,
1448
1441
- returns None on error (provided default value)
1450
# Note to implementors: if changing the rules for determining the width,
1451
# make sure you've considered the behaviour in these cases:
1452
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1453
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1455
# - (add more interesting cases here, if you find any)
1456
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1457
# but we don't want to register a signal handler because it is impossible
1458
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1459
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1460
# time so we can notice if the reported size has changed, which should have
1463
1444
# If BZR_COLUMNS is set, take it, user is always right
1469
1450
isatty = getattr(sys.stdout, 'isatty', None)
1470
if isatty is None or not isatty():
1451
if isatty is None or not isatty():
1471
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1475
width, height = os_size = _terminal_size(None, None)
1476
global _first_terminal_size, _terminal_size_state
1477
if _terminal_size_state == 'no_data':
1478
_first_terminal_size = os_size
1479
_terminal_size_state = 'unchanged'
1480
elif (_terminal_size_state == 'unchanged' and
1481
_first_terminal_size != os_size):
1482
_terminal_size_state = 'changed'
1484
# If the OS claims to know how wide the terminal is, and this value has
1485
# ever changed, use that.
1486
if _terminal_size_state == 'changed':
1487
if width is not None and width > 0:
1490
# If COLUMNS is set, use it.
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))
1492
1459
return int(os.environ['COLUMNS'])
1493
1460
except (KeyError, ValueError):
1496
# Finally, use an unchanged size from the OS, if we have one.
1497
if _terminal_size_state == 'unchanged':
1498
if width is not None and width > 0:
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1501
# The width could not be determined.
1505
1471
def _win32_terminal_size(width, height):
1532
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
1523
_registered_sigwinch = True
1535
1526
def supports_executable():
1536
1527
return sys.platform != "win32"
1874
1865
s = os.stat(src)
1875
1866
chown(dst, s.st_uid, s.st_gid)
1876
1867
except OSError, e:
1878
'Unable to copy ownership from "%s" to "%s". '
1879
'You may want to set it manually.', src, dst)
1880
trace.log_exception_quietly()
1868
trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1883
1871
def path_prefix_key(path):
2044
2028
def send_all(sock, bytes, report_activity=None):
2045
2029
"""Send all bytes on a socket.
2047
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2048
2032
some platforms, and catches EINTR which may be thrown if the send is
2049
2033
interrupted by a signal.
2051
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2052
2036
and provides activity reporting.
2054
2038
:param report_activity: Call this as bytes are read, see
2055
2039
Transport._report_activity
2067
2051
report_activity(sent, 'write')
2070
def connect_socket(address):
2071
# Slight variation of the socket.create_connection() function (provided by
2072
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2073
# provide it for previous python versions. Also, we don't use the timeout
2074
# parameter (provided by the python implementation) so we don't implement
2076
err = socket.error('getaddrinfo returns an empty list')
2077
host, port = address
2078
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2079
af, socktype, proto, canonname, sa = res
2082
sock = socket.socket(af, socktype, proto)
2086
except socket.error, err:
2087
# 'err' is now the most recent error
2088
if sock is not None:
2093
2054
def dereference_path(path):
2094
2055
"""Determine the real path to a file.
2134
2095
base = dirname(bzrlib.__file__)
2135
2096
if getattr(sys, 'frozen', None): # bzr.exe
2136
2097
base = abspath(pathjoin(base, '..', '..'))
2137
f = file(pathjoin(base, resource_relpath), "rU")
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2143
2102
def file_kind_from_stat_mode_thunk(mode):
2144
2103
global file_kind_from_stat_mode
2168
2127
def until_no_eintr(f, *a, **kw):
2169
2128
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2171
2130
WARNING: you must be certain that it is safe to retry the call repeatedly
2172
2131
if EINTR does occur. This is typically only true for low-level operations
2173
2132
like os.read. If in any doubt, don't use this.
2191
@deprecated_function(deprecated_in((2, 2, 0)))
2192
2150
def re_compile_checked(re_string, flags=0, where=""):
2193
2151
"""Return a compiled re, or raise a sensible error.
2204
2162
re_obj = re.compile(re_string, flags)
2205
2163
re_obj.search("")
2207
except errors.InvalidPattern, e:
2209
2167
where = ' in ' + where
2210
2168
# despite the name 'error' is a type
2211
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2169
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
% (where, re_string, e))
2215
2173
if sys.platform == "win32":
2305
2263
if sys.platform == 'win32':
2306
2264
def open_file(filename, mode='r', bufsize=-1):
2307
2265
"""This function is used to override the ``open`` builtin.
2309
2267
But it uses O_NOINHERIT flag so the file handle is not inherited by
2310
2268
child processes. Deleting or renaming a closed file opened with this
2311
2269
function is not blocking child processes.
2344
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
2346
2304
open_file = open
2349
def getuser_unicode():
2350
"""Return the username as unicode.
2353
user_encoding = get_user_encoding()
2354
username = getpass.getuser().decode(user_encoding)
2355
except UnicodeDecodeError:
2356
raise errors.BzrError("Can't decode username as %s." % \
2361
def available_backup_name(base, exists):
2362
"""Find a non-existing backup file name.
2364
This will *not* create anything, this only return a 'free' entry. This
2365
should be used for checking names in a directory below a locked
2366
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2367
Leap) and generally discouraged.
2369
:param base: The base name.
2371
:param exists: A callable returning True if the path parameter exists.
2374
name = "%s.~%d~" % (base, counter)
2377
name = "%s.~%d~" % (base, counter)
added
removed
bzrlib/osutils.py
