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)
27
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
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
46
from tempfile import (
40
from tempfile import mkdtemp
51
43
from bzrlib import (
306
298
running python.exe under cmd.exe return capital C:\\
307
299
running win32 python inside a cygwin shell returns lowercase c:\\
309
drive, path = _nt_splitdrive(path)
301
drive, path = ntpath.splitdrive(path)
310
302
return drive.upper() + path
313
305
def _win32_abspath(path):
314
# Real _nt_abspath doesn't have a problem with a unicode cwd
315
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
318
310
def _win98_abspath(path):
329
321
# /path => C:/path
330
322
path = unicode(path)
331
323
# check for absolute path
332
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
333
325
if drive == '' and path[:2] not in('//','\\\\'):
334
326
cwd = os.getcwdu()
335
327
# we cannot simply os.path.join cwd and path
336
328
# because os.path.join('C:','/path') produce '/path'
337
329
# and this is incorrect
338
330
if path[:1] in ('/','\\'):
339
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
341
333
path = cwd + '\\' + path
342
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
345
337
def _win32_realpath(path):
346
# Real _nt_realpath doesn't have a problem with a unicode cwd
347
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
350
342
def _win32_pathjoin(*args):
351
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
354
346
def _win32_normpath(path):
355
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
358
350
def _win32_getcwd():
397
389
basename = os.path.basename
398
390
split = os.path.split
399
391
splitext = os.path.splitext
400
# These were already imported into local scope
392
# These were already lazily imported into local scope
401
393
# mkdtemp = tempfile.mkdtemp
402
394
# rmtree = shutil.rmtree
456
448
On my standard US Windows XP, the preferred encoding is
457
449
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
459
453
from bzrlib.trace import mutter
460
454
output_encoding = getattr(sys.stdout, 'encoding', None)
462
456
input_encoding = getattr(sys.stdin, 'encoding', None)
463
457
if not input_encoding:
464
458
output_encoding = get_user_encoding()
465
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
468
463
output_encoding = input_encoding
469
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
465
mutter('encoding stdout as sys.stdin encoding %r',
471
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
472
470
if output_encoding == 'cp0':
473
471
# invalid encoding (cp0 means 'no codepage' on Windows)
474
472
output_encoding = get_user_encoding()
475
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
476
475
' encoding stdout as osutils.get_user_encoding() %r',
513
512
"""True if f is a regular file."""
515
return S_ISREG(os.lstat(f)[ST_MODE])
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
520
519
"""True if f is a symlink."""
522
return S_ISLNK(os.lstat(f)[ST_MODE])
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
934
933
def parent_directories(filename):
935
934
"""Return the list of parent directories, deepest first.
937
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
963
962
# NB: This docstring is just an example, not a doctest, because doctest
964
963
# currently can't cope with the use of lazy imports in this namespace --
967
966
# This currently doesn't report the failure at the time it occurs, because
968
967
# they tend to happen very early in startup when we can't check config
969
968
# files etc, and also we want to report all failures but not spam the user
970
969
# with 10 warnings.
971
from bzrlib import trace
972
970
exception_str = str(exception)
973
971
if exception_str not in _extension_load_failures:
974
972
trace.mutter("failed to load compiled extension: %s" % exception_str)
1134
1132
def relpath(base, path):
1135
"""Return path relative to base, or raise exception.
1133
"""Return path relative to base, or raise PathNotChild exception.
1137
1135
The path may be either an absolute path or a path relative to the
1138
1136
current working directory.
1140
1138
os.path.commonprefix (python2.4) has a bad bug that it works just
1141
1139
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1142
1140
avoids that problem.
1142
NOTE: `base` should not have a trailing slash otherwise you'll get
1143
PathNotChild exceptions regardless of `path`.
1145
1146
if len(base) < MIN_ABS_PATHLENGTH:
1232
1233
# but for now, we haven't optimized...
1233
1234
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)
1235
1252
def safe_unicode(unicode_or_utf8_string):
1236
1253
"""Coerce unicode_or_utf8_string into unicode.
1320
1337
def normalizes_filenames():
1321
1338
"""Return True if this platform normalizes unicode filenames.
1323
Mac OSX does, Windows/Linux do not.
1325
1342
return _platform_normalizes_filenames
1331
1348
On platforms where the system normalizes filenames (Mac OSX),
1332
1349
you can access a file by any path which will normalize correctly.
1333
1350
On platforms where the system does not normalize filenames
1334
(Windows, Linux), you have to access a file by its exact path.
1351
(everything else), you have to access a file by its exact path.
1336
1353
Internally, bzr only supports NFC normalization, since that is
1337
1354
the standard for XML documents.
1365
1382
False)`). May be ignored if the feature is not available on this
1366
1383
platform or Python version.
1368
old_handler = signal.signal(signum, handler)
1387
siginterrupt = signal.siginterrupt
1389
# This python implementation doesn't provide signal support, hence no
1392
except AttributeError:
1393
# siginterrupt doesn't exist on this platform, or for this version
1395
siginterrupt = lambda signum, flag: None
1369
1396
if restart_syscall:
1371
siginterrupt = signal.siginterrupt
1372
except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
1397
def sig_handler(*args):
1398
# Python resets the siginterrupt flag when a signal is
1399
# received. <http://bugs.python.org/issue8354>
1400
# As a workaround for some cases, set it back the way we want it.
1376
1401
siginterrupt(signum, False)
1402
# Now run the handler function passed to set_signal_handler.
1405
sig_handler = handler
1406
old_handler = signal.signal(signum, sig_handler)
1408
siginterrupt(signum, False)
1377
1409
return old_handler
1384
1416
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
1388
1426
def terminal_width():
1389
1427
"""Return terminal width.
1394
1432
- if BZR_COLUMNS is set, returns its value
1395
1433
- if there is no controlling terminal, returns None
1434
- query the OS, if the queried size has changed since the last query,
1396
1436
- if COLUMNS is set, returns its value,
1437
- if the OS has a value (even though it's never changed), return its value.
1398
1439
From there, we need to query the OS to get the size of the controlling
1442
On Unices we query the OS by:
1402
1443
- get termios.TIOCGWINSZ
1403
1444
- if an error occurs or a negative value is obtained, returns None
1446
On Windows we query the OS by:
1407
1447
- win32utils.get_console_size() decides,
1408
1448
- 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
1411
1463
# If BZR_COLUMNS is set, take it, user is always right
1417
1469
isatty = getattr(sys.stdout, 'isatty', None)
1418
if isatty is None or not isatty():
1470
if isatty is None or not isatty():
1419
1471
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1422
# If COLUMNS is set, take it, the terminal knows better (even inside a
1423
# given terminal, the application can decide to set COLUMNS to a lower
1424
# value (splitted screen) or a bigger value (scroll bars))
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.
1426
1492
return int(os.environ['COLUMNS'])
1427
1493
except (KeyError, ValueError):
1430
width, height = _terminal_size(None, None)
1432
# Consider invalid values as meaning no width
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:
1501
# The width could not be determined.
1438
1505
def _win32_terminal_size(width, height):
1465
1532
_terminal_size = _ioctl_terminal_size
1468
def _terminal_size_changed(signum, frame):
1469
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1470
width, height = _terminal_size(None, None)
1471
if width is not None:
1472
os.environ['COLUMNS'] = str(width)
1475
_registered_sigwinch = False
1477
def watch_sigwinch():
1478
"""Register for SIGWINCH, once and only once."""
1479
global _registered_sigwinch
1480
if not _registered_sigwinch:
1481
if sys.platform == 'win32':
1482
# Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
1483
# ReadConsoleInput but I've no idea how to plug that in
1484
# the current design -- vila 20091216
1487
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1488
_registered_sigwinch = True
1491
1535
def supports_executable():
1492
1536
return sys.platform != "win32"
1811
1855
real_handlers[kind](abspath, relpath)
1814
def copy_ownership(dst, src=None):
1858
def copy_ownership_from_path(dst, src=None):
1815
1859
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1817
1861
If src is None, the containing directory is used as source. If chown
1830
1874
s = os.stat(src)
1831
1875
chown(dst, s.st_uid, s.st_gid)
1832
1876
except OSError, e:
1833
trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1836
def mkdir_with_ownership(path, ownership_src=None):
1837
"""Create the directory 'path' with specified ownership.
1839
If ownership_src is given, copies (chown) usr/grp ownership
1840
from 'ownership_src' to 'path'. If ownership_src is None, use the
1841
containing dir ownership.
1844
copy_ownership(path, ownership_src)
1847
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
1848
"""Open the file 'filename' with the specified ownership.
1850
If ownership_src is specified, copy usr/grp ownership from ownership_src
1851
to filename. If ownership_src is None, copy ownership from containing
1853
Returns the opened file object.
1855
f = open(filename, mode, bufsize)
1856
copy_ownership(filename, ownership_src)
1878
'Unable to copy ownership from "%s" to "%s". '
1879
'You may want to set it manually.', src, dst)
1880
trace.log_exception_quietly()
1860
1883
def path_prefix_key(path):
2017
2044
def send_all(sock, bytes, report_activity=None):
2018
2045
"""Send all bytes on a socket.
2020
2047
Breaks large blocks in smaller chunks to avoid buffering limitations on
2021
2048
some platforms, and catches EINTR which may be thrown if the send is
2022
2049
interrupted by a signal.
2024
2051
This is preferred to socket.sendall(), because it avoids portability bugs
2025
2052
and provides activity reporting.
2027
2054
:param report_activity: Call this as bytes are read, see
2028
2055
Transport._report_activity
2040
2067
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:
2043
2093
def dereference_path(path):
2044
2094
"""Determine the real path to a file.
2084
2134
base = dirname(bzrlib.__file__)
2085
2135
if getattr(sys, 'frozen', None): # bzr.exe
2086
2136
base = abspath(pathjoin(base, '..', '..'))
2087
filename = pathjoin(base, resource_relpath)
2088
return open(filename, 'rU').read()
2137
f = file(pathjoin(base, resource_relpath), "rU")
2091
2143
def file_kind_from_stat_mode_thunk(mode):
2092
2144
global file_kind_from_stat_mode
2116
2168
def until_no_eintr(f, *a, **kw):
2117
2169
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2119
2171
WARNING: you must be certain that it is safe to retry the call repeatedly
2120
2172
if EINTR does occur. This is typically only true for low-level operations
2121
2173
like os.read. If in any doubt, don't use this.
2191
@deprecated_function(deprecated_in((2, 2, 0)))
2139
2192
def re_compile_checked(re_string, flags=0, where=""):
2140
2193
"""Return a compiled re, or raise a sensible error.
2151
2204
re_obj = re.compile(re_string, flags)
2152
2205
re_obj.search("")
2207
except errors.InvalidPattern, e:
2156
2209
where = ' in ' + where
2157
2210
# despite the name 'error' is a type
2158
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2159
% (where, re_string, e))
2211
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2162
2215
if sys.platform == "win32":
2252
2305
if sys.platform == 'win32':
2253
2306
def open_file(filename, mode='r', bufsize=-1):
2254
2307
"""This function is used to override the ``open`` builtin.
2256
2309
But it uses O_NOINHERIT flag so the file handle is not inherited by
2257
2310
child processes. Deleting or renaming a closed file opened with this
2258
2311
function is not blocking child processes.
2291
2344
return os.fdopen(os.open(filename, flags), mode, bufsize)
2293
2346
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
