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
from shutil import rmtree
43
from tempfile import (
34
import tempfile import mkdtemp
48
37
from bzrlib import (
303
292
running python.exe under cmd.exe return capital C:\\
304
293
running win32 python inside a cygwin shell returns lowercase c:\\
306
drive, path = _nt_splitdrive(path)
295
drive, path = ntpath.splitdrive(path)
307
296
return drive.upper() + path
310
299
def _win32_abspath(path):
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
300
# Real ntpath.abspath doesn't have a problem with a unicode cwd
301
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
315
304
def _win98_abspath(path):
326
315
# /path => C:/path
327
316
path = unicode(path)
328
317
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
318
drive = ntpath.splitdrive(path)[0]
330
319
if drive == '' and path[:2] not in('//','\\\\'):
331
320
cwd = os.getcwdu()
332
321
# we cannot simply os.path.join cwd and path
333
322
# because os.path.join('C:','/path') produce '/path'
334
323
# and this is incorrect
335
324
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
325
cwd = ntpath.splitdrive(cwd)[0]
338
327
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
328
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
331
def _win32_realpath(path):
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
332
# Real ntpath.realpath doesn't have a problem with a unicode cwd
333
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
336
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
337
return ntpath.join(*args).replace('\\', '/')
351
340
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
341
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
344
def _win32_getcwd():
360
349
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
352
def _win32_rename(old, new):
372
353
"""We expect to be able to atomically replace 'new' with old.
375
356
and then deleted.
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
359
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
360
except OSError, e:
380
361
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
362
# 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)
399
370
def _mac_getcwd():
400
371
return unicodedata.normalize('NFC', os.getcwdu())
406
377
realpath = _posix_realpath
407
378
pathjoin = os.path.join
408
379
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
410
380
getcwd = os.getcwdu
411
382
dirname = os.path.dirname
412
383
basename = os.path.basename
413
384
split = os.path.split
414
385
splitext = os.path.splitext
415
# These were already imported into local scope
386
# These were already lazily imported into local scope
416
387
# mkdtemp = tempfile.mkdtemp
417
388
# rmtree = shutil.rmtree
471
442
On my standard US Windows XP, the preferred encoding is
472
443
cp1252, but the console is cp437
445
:param trace: If True trace the selected encoding via mutter().
474
447
from bzrlib.trace import mutter
475
448
output_encoding = getattr(sys.stdout, 'encoding', None)
477
450
input_encoding = getattr(sys.stdin, 'encoding', None)
478
451
if not input_encoding:
479
452
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
454
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
457
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
459
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
463
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
464
if output_encoding == 'cp0':
488
465
# invalid encoding (cp0 means 'no codepage' on Windows)
489
466
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
468
mutter('cp0 is invalid encoding.'
491
469
' encoding stdout as osutils.get_user_encoding() %r',
528
506
"""True if f is a regular file."""
530
return S_ISREG(os.lstat(f)[ST_MODE])
508
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
535
513
"""True if f is a symlink."""
537
return S_ISLNK(os.lstat(f)[ST_MODE])
515
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
949
927
def parent_directories(filename):
950
928
"""Return the list of parent directories, deepest first.
952
930
For example, parent_directories("a/b/c") -> ["a/b", "a"].
978
956
# NB: This docstring is just an example, not a doctest, because doctest
979
957
# currently can't cope with the use of lazy imports in this namespace --
982
960
# This currently doesn't report the failure at the time it occurs, because
983
961
# they tend to happen very early in startup when we can't check config
984
962
# files etc, and also we want to report all failures but not spam the user
1250
1228
# but for now, we haven't optimized...
1251
1229
return [canonical_relpath(base, p) for p in paths]
1232
def decode_filename(filename):
1233
"""Decode the filename using the filesystem encoding
1235
If it is unicode, it is returned.
1236
Otherwise it is decoded from the the filesystem's encoding. If decoding
1237
fails, a errors.BadFilenameEncoding exception is raised.
1239
if type(filename) is unicode:
1242
return filename.decode(_fs_enc)
1243
except UnicodeDecodeError:
1244
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1247
def safe_unicode(unicode_or_utf8_string):
1254
1248
"""Coerce unicode_or_utf8_string into unicode.
1338
1332
def normalizes_filenames():
1339
1333
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1343
1337
return _platform_normalizes_filenames
1349
1343
On platforms where the system normalizes filenames (Mac OSX),
1350
1344
you can access a file by any path which will normalize correctly.
1351
1345
On platforms where the system does not normalize filenames
1352
(Windows, Linux), you have to access a file by its exact path.
1346
(everything else), you have to access a file by its exact path.
1354
1348
Internally, bzr only supports NFC normalization, since that is
1355
1349
the standard for XML documents.
1417
1411
terminal_width() returns None.
1414
# Keep some state so that terminal_width can detect if _terminal_size has
1415
# returned a different size since the process started. See docstring and
1416
# comments of terminal_width for details.
1417
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1418
_terminal_size_state = 'no_data'
1419
_first_terminal_size = None
1421
1421
def terminal_width():
1422
1422
"""Return terminal width.
1427
1427
- if BZR_COLUMNS is set, returns its value
1428
1428
- if there is no controlling terminal, returns None
1429
- query the OS, if the queried size has changed since the last query,
1429
1431
- if COLUMNS is set, returns its value,
1432
- if the OS has a value (even though it's never changed), return its value.
1431
1434
From there, we need to query the OS to get the size of the controlling
1437
On Unices we query the OS by:
1435
1438
- get termios.TIOCGWINSZ
1436
1439
- if an error occurs or a negative value is obtained, returns None
1441
On Windows we query the OS by:
1440
1442
- win32utils.get_console_size() decides,
1441
1443
- returns None on error (provided default value)
1445
# Note to implementors: if changing the rules for determining the width,
1446
# make sure you've considered the behaviour in these cases:
1447
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1448
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1450
# - (add more interesting cases here, if you find any)
1451
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1452
# but we don't want to register a signal handler because it is impossible
1453
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1454
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1455
# time so we can notice if the reported size has changed, which should have
1444
1458
# If BZR_COLUMNS is set, take it, user is always right
1450
1464
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1465
if isatty is None or not isatty():
1452
1466
# 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))
1470
width, height = os_size = _terminal_size(None, None)
1471
global _first_terminal_size, _terminal_size_state
1472
if _terminal_size_state == 'no_data':
1473
_first_terminal_size = os_size
1474
_terminal_size_state = 'unchanged'
1475
elif (_terminal_size_state == 'unchanged' and
1476
_first_terminal_size != os_size):
1477
_terminal_size_state = 'changed'
1479
# If the OS claims to know how wide the terminal is, and this value has
1480
# ever changed, use that.
1481
if _terminal_size_state == 'changed':
1482
if width is not None and width > 0:
1485
# If COLUMNS is set, use it.
1459
1487
return int(os.environ['COLUMNS'])
1460
1488
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1491
# Finally, use an unchanged size from the OS, if we have one.
1492
if _terminal_size_state == 'unchanged':
1493
if width is not None and width > 0:
1496
# The width could not be determined.
1471
1500
def _win32_terminal_size(width, height):
1498
1527
_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
1526
1530
def supports_executable():
1527
1531
return sys.platform != "win32"
2028
2036
def send_all(sock, bytes, report_activity=None):
2029
2037
"""Send all bytes on a socket.
2031
2039
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2040
some platforms, and catches EINTR which may be thrown if the send is
2033
2041
interrupted by a signal.
2035
2043
This is preferred to socket.sendall(), because it avoids portability bugs
2036
2044
and provides activity reporting.
2038
2046
:param report_activity: Call this as bytes are read, see
2039
2047
Transport._report_activity
2051
2059
report_activity(sent, 'write')
2062
def connect_socket(address, timeout=None):
2063
# Slight variation of the socket.create_connection() function (provided
2064
# by python-2.6) that can fail if getaddrinfo returns an empty list. We
2065
# also provide it for previous python versions. Also, we don't use the
2066
# timeout parameter so we don't implement it either.
2067
err = socket.error('getaddrinfo returns an empty list')
2068
host, port = address
2069
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2070
af, socktype, proto, canonname, sa = res
2073
sock = socket.socket(af, socktype, proto)
2077
except socket.error, err:
2078
# 'err' is now the most recent error
2079
if sock is not None:
2054
2084
def dereference_path(path):
2055
2085
"""Determine the real path to a file.
2095
2125
base = dirname(bzrlib.__file__)
2096
2126
if getattr(sys, 'frozen', None): # bzr.exe
2097
2127
base = abspath(pathjoin(base, '..', '..'))
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2128
f = file(pathjoin(base, resource_relpath), "rU")
2102
2134
def file_kind_from_stat_mode_thunk(mode):
2103
2135
global file_kind_from_stat_mode
2127
2159
def until_no_eintr(f, *a, **kw):
2128
2160
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2162
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2163
if EINTR does occur. This is typically only true for low-level operations
2132
2164
like os.read. If in any doubt, don't use this.
2263
2295
if sys.platform == 'win32':
2264
2296
def open_file(filename, mode='r', bufsize=-1):
2265
2297
"""This function is used to override the ``open`` builtin.
2267
2299
But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2300
child processes. Deleting or renaming a closed file opened with this
2269
2301
function is not blocking child processes.
2302
2334
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2336
open_file = open
2339
def getuser_unicode():
2340
"""Return the username as unicode.
2343
user_encoding = get_user_encoding()
2344
username = getpass.getuser().decode(user_encoding)
2345
except UnicodeDecodeError:
2346
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
