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
27
from bzrlib.lazy_import import lazy_import
26
28
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
46
from tempfile import (
43
51
from bzrlib import (
298
306
running python.exe under cmd.exe return capital C:\\
299
307
running win32 python inside a cygwin shell returns lowercase c:\\
301
drive, path = ntpath.splitdrive(path)
309
drive, path = _nt_splitdrive(path)
302
310
return drive.upper() + path
305
313
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('\\', '/'))
314
# Real _nt_abspath doesn't have a problem with a unicode cwd
315
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
310
318
def _win98_abspath(path):
321
329
# /path => C:/path
322
330
path = unicode(path)
323
331
# check for absolute path
324
drive = ntpath.splitdrive(path)[0]
332
drive = _nt_splitdrive(path)[0]
325
333
if drive == '' and path[:2] not in('//','\\\\'):
326
334
cwd = os.getcwdu()
327
335
# we cannot simply os.path.join cwd and path
328
336
# because os.path.join('C:','/path') produce '/path'
329
337
# and this is incorrect
330
338
if path[:1] in ('/','\\'):
331
cwd = ntpath.splitdrive(cwd)[0]
339
cwd = _nt_splitdrive(cwd)[0]
333
341
path = cwd + '\\' + path
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
337
345
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('\\', '/'))
346
# Real _nt_realpath doesn't have a problem with a unicode cwd
347
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
342
350
def _win32_pathjoin(*args):
343
return ntpath.join(*args).replace('\\', '/')
351
return _nt_join(*args).replace('\\', '/')
346
354
def _win32_normpath(path):
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
350
358
def _win32_getcwd():
389
397
basename = os.path.basename
390
398
split = os.path.split
391
399
splitext = os.path.splitext
392
# These were already lazily imported into local scope
400
# These were already imported into local scope
393
401
# mkdtemp = tempfile.mkdtemp
394
402
# rmtree = shutil.rmtree
448
456
On my standard US Windows XP, the preferred encoding is
449
457
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
453
459
from bzrlib.trace import mutter
454
460
output_encoding = getattr(sys.stdout, 'encoding', None)
456
462
input_encoding = getattr(sys.stdin, 'encoding', None)
457
463
if not input_encoding:
458
464
output_encoding = get_user_encoding()
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
465
mutter('encoding stdout as osutils.get_user_encoding() %r',
463
468
output_encoding = input_encoding
465
mutter('encoding stdout as sys.stdin encoding %r',
469
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
471
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
472
if output_encoding == 'cp0':
471
473
# invalid encoding (cp0 means 'no codepage' on Windows)
472
474
output_encoding = get_user_encoding()
474
mutter('cp0 is invalid encoding.'
475
mutter('cp0 is invalid encoding.'
475
476
' encoding stdout as osutils.get_user_encoding() %r',
512
513
"""True if f is a regular file."""
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
515
return S_ISREG(os.lstat(f)[ST_MODE])
519
520
"""True if f is a symlink."""
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
522
return S_ISLNK(os.lstat(f)[ST_MODE])
933
934
def parent_directories(filename):
934
935
"""Return the list of parent directories, deepest first.
936
937
For example, parent_directories("a/b/c") -> ["a/b", "a"].
962
963
# NB: This docstring is just an example, not a doctest, because doctest
963
964
# currently can't cope with the use of lazy imports in this namespace --
966
967
# This currently doesn't report the failure at the time it occurs, because
967
968
# they tend to happen very early in startup when we can't check config
968
969
# files etc, and also we want to report all failures but not spam the user
1133
1134
def relpath(base, path):
1134
"""Return path relative to base, or raise PathNotChild exception.
1135
"""Return path relative to base, or raise exception.
1136
1137
The path may be either an absolute path or a path relative to the
1137
1138
current working directory.
1139
1140
os.path.commonprefix (python2.4) has a bad bug that it works just
1140
1141
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1141
1142
avoids that problem.
1143
NOTE: `base` should not have a trailing slash otherwise you'll get
1144
PathNotChild exceptions regardless of `path`.
1147
1145
if len(base) < MIN_ABS_PATHLENGTH:
1234
1232
# but for now, we haven't optimized...
1235
1233
return [canonical_relpath(base, p) for p in paths]
1238
def decode_filename(filename):
1239
"""Decode the filename using the filesystem encoding
1241
If it is unicode, it is returned.
1242
Otherwise it is decoded from the the filesystem's encoding. If decoding
1243
fails, a errors.BadFilenameEncoding exception is raised.
1245
if type(filename) is unicode:
1248
return filename.decode(_fs_enc)
1249
except UnicodeDecodeError:
1250
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1235
def safe_unicode(unicode_or_utf8_string):
1254
1236
"""Coerce unicode_or_utf8_string into unicode.
1338
1320
def normalizes_filenames():
1339
1321
"""Return True if this platform normalizes unicode filenames.
1323
Mac OSX does, Windows/Linux do not.
1343
1325
return _platform_normalizes_filenames
1349
1331
On platforms where the system normalizes filenames (Mac OSX),
1350
1332
you can access a file by any path which will normalize correctly.
1351
1333
On platforms where the system does not normalize filenames
1352
(everything else), you have to access a file by its exact path.
1334
(Windows, Linux), you have to access a file by its exact path.
1354
1336
Internally, bzr only supports NFC normalization, since that is
1355
1337
the standard for XML documents.
1383
1365
False)`). May be ignored if the feature is not available on this
1384
1366
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
1368
old_handler = signal.signal(signum, handler)
1397
1369
if restart_syscall:
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.
1371
siginterrupt = signal.siginterrupt
1372
except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
1402
1376
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)
1410
1377
return old_handler
1417
1384
terminal_width() returns None.
1420
# Keep some state so that terminal_width can detect if _terminal_size has
1421
# returned a different size since the process started. See docstring and
1422
# comments of terminal_width for details.
1423
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1424
_terminal_size_state = 'no_data'
1425
_first_terminal_size = None
1427
1388
def terminal_width():
1428
1389
"""Return terminal width.
1433
1394
- if BZR_COLUMNS is set, returns its value
1434
1395
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1437
1396
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1440
1398
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1444
1402
- get termios.TIOCGWINSZ
1445
1403
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1448
1407
- win32utils.get_console_size() decides,
1449
1408
- returns None on error (provided default value)
1451
# Note to implementors: if changing the rules for determining the width,
1452
# make sure you've considered the behaviour in these cases:
1453
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1454
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1456
# - (add more interesting cases here, if you find any)
1457
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1458
# but we don't want to register a signal handler because it is impossible
1459
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1460
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1461
# time so we can notice if the reported size has changed, which should have
1464
1411
# If BZR_COLUMNS is set, take it, user is always right
1470
1417
isatty = getattr(sys.stdout, 'isatty', None)
1471
if isatty is None or not isatty():
1418
if isatty is None or not isatty():
1472
1419
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1476
width, height = os_size = _terminal_size(None, None)
1477
global _first_terminal_size, _terminal_size_state
1478
if _terminal_size_state == 'no_data':
1479
_first_terminal_size = os_size
1480
_terminal_size_state = 'unchanged'
1481
elif (_terminal_size_state == 'unchanged' and
1482
_first_terminal_size != os_size):
1483
_terminal_size_state = 'changed'
1485
# If the OS claims to know how wide the terminal is, and this value has
1486
# ever changed, use that.
1487
if _terminal_size_state == 'changed':
1488
if width is not None and width > 0:
1491
# If COLUMNS is set, use it.
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))
1493
1426
return int(os.environ['COLUMNS'])
1494
1427
except (KeyError, ValueError):
1497
# Finally, use an unchanged size from the OS, if we have one.
1498
if _terminal_size_state == 'unchanged':
1499
if width is not None and width > 0:
1430
width, height = _terminal_size(None, None)
1432
# Consider invalid values as meaning no width
1502
# The width could not be determined.
1506
1438
def _win32_terminal_size(width, height):
1533
1465
_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
1536
1491
def supports_executable():
1537
1492
return sys.platform != "win32"
1856
1811
real_handlers[kind](abspath, relpath)
1859
def copy_ownership_from_path(dst, src=None):
1814
def copy_ownership(dst, src=None):
1860
1815
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1862
1817
If src is None, the containing directory is used as source. If chown
1878
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)
1881
1860
def path_prefix_key(path):
1882
1861
"""Generate a prefix-order path key for path.
2042
2017
def send_all(sock, bytes, report_activity=None):
2043
2018
"""Send all bytes on a socket.
2045
2020
Breaks large blocks in smaller chunks to avoid buffering limitations on
2046
2021
some platforms, and catches EINTR which may be thrown if the send is
2047
2022
interrupted by a signal.
2049
2024
This is preferred to socket.sendall(), because it avoids portability bugs
2050
2025
and provides activity reporting.
2052
2027
:param report_activity: Call this as bytes are read, see
2053
2028
Transport._report_activity
2065
2040
report_activity(sent, 'write')
2068
def connect_socket(address):
2069
# Slight variation of the socket.create_connection() function (provided by
2070
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2071
# provide it for previous python versions. Also, we don't use the timeout
2072
# parameter (provided by the python implementation) so we don't implement
2074
err = socket.error('getaddrinfo returns an empty list')
2075
host, port = address
2076
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2077
af, socktype, proto, canonname, sa = res
2080
sock = socket.socket(af, socktype, proto)
2084
except socket.error, err:
2085
# 'err' is now the most recent error
2086
if sock is not None:
2091
2043
def dereference_path(path):
2092
2044
"""Determine the real path to a file.
2132
2084
base = dirname(bzrlib.__file__)
2133
2085
if getattr(sys, 'frozen', None): # bzr.exe
2134
2086
base = abspath(pathjoin(base, '..', '..'))
2135
f = file(pathjoin(base, resource_relpath), "rU")
2087
filename = pathjoin(base, resource_relpath)
2088
return open(filename, 'rU').read()
2141
2091
def file_kind_from_stat_mode_thunk(mode):
2142
2092
global file_kind_from_stat_mode
2166
2116
def until_no_eintr(f, *a, **kw):
2167
2117
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2169
2119
WARNING: you must be certain that it is safe to retry the call repeatedly
2170
2120
if EINTR does occur. This is typically only true for low-level operations
2171
2121
like os.read. If in any doubt, don't use this.
2189
@deprecated_function(deprecated_in((2, 2, 0)))
2190
2139
def re_compile_checked(re_string, flags=0, where=""):
2191
2140
"""Return a compiled re, or raise a sensible error.
2202
2151
re_obj = re.compile(re_string, flags)
2203
2152
re_obj.search("")
2205
except errors.InvalidPattern, e:
2207
2156
where = ' in ' + where
2208
2157
# despite the name 'error' is a type
2209
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2158
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2159
% (where, re_string, e))
2213
2162
if sys.platform == "win32":
2303
2252
if sys.platform == 'win32':
2304
2253
def open_file(filename, mode='r', bufsize=-1):
2305
2254
"""This function is used to override the ``open`` builtin.
2307
2256
But it uses O_NOINHERIT flag so the file handle is not inherited by
2308
2257
child processes. Deleting or renaming a closed file opened with this
2309
2258
function is not blocking child processes.
2342
2291
return os.fdopen(os.open(filename, flags), mode, bufsize)
2344
2293
open_file = open
2347
def getuser_unicode():
2348
"""Return the username as unicode.
2351
user_encoding = get_user_encoding()
2352
username = getpass.getuser().decode(user_encoding)
2353
except UnicodeDecodeError:
2354
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
