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
43
from tempfile import (
40
from tempfile import mkdtemp
48
43
from bzrlib import (
303
298
running python.exe under cmd.exe return capital C:\\
304
299
running win32 python inside a cygwin shell returns lowercase c:\\
306
drive, path = _nt_splitdrive(path)
301
drive, path = ntpath.splitdrive(path)
307
302
return drive.upper() + path
310
305
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('\\', '/'))
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
315
310
def _win98_abspath(path):
326
321
# /path => C:/path
327
322
path = unicode(path)
328
323
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
330
325
if drive == '' and path[:2] not in('//','\\\\'):
331
326
cwd = os.getcwdu()
332
327
# we cannot simply os.path.join cwd and path
333
328
# because os.path.join('C:','/path') produce '/path'
334
329
# and this is incorrect
335
330
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
338
333
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
337
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('\\', '/'))
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
342
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
351
346
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
350
def _win32_getcwd():
360
355
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
358
def _win32_rename(old, new):
372
359
"""We expect to be able to atomically replace 'new' with old.
375
362
and then deleted.
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
365
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
366
except OSError, e:
380
367
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
368
# 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
376
def _mac_getcwd():
400
377
return unicodedata.normalize('NFC', os.getcwdu())
406
383
realpath = _posix_realpath
407
384
pathjoin = os.path.join
408
385
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
410
386
getcwd = os.getcwdu
411
388
dirname = os.path.dirname
412
389
basename = os.path.basename
413
390
split = os.path.split
414
391
splitext = os.path.splitext
415
# These were already imported into local scope
392
# These were already lazily imported into local scope
416
393
# mkdtemp = tempfile.mkdtemp
417
394
# rmtree = shutil.rmtree
471
448
On my standard US Windows XP, the preferred encoding is
472
449
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
474
453
from bzrlib.trace import mutter
475
454
output_encoding = getattr(sys.stdout, 'encoding', None)
477
456
input_encoding = getattr(sys.stdin, 'encoding', None)
478
457
if not input_encoding:
479
458
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
463
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
465
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
470
if output_encoding == 'cp0':
488
471
# invalid encoding (cp0 means 'no codepage' on Windows)
489
472
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
491
475
' encoding stdout as osutils.get_user_encoding() %r',
528
512
"""True if f is a regular file."""
530
return S_ISREG(os.lstat(f)[ST_MODE])
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
535
519
"""True if f is a symlink."""
537
return S_ISLNK(os.lstat(f)[ST_MODE])
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
949
933
def parent_directories(filename):
950
934
"""Return the list of parent directories, deepest first.
952
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
978
962
# NB: This docstring is just an example, not a doctest, because doctest
979
963
# currently can't cope with the use of lazy imports in this namespace --
982
966
# This currently doesn't report the failure at the time it occurs, because
983
967
# they tend to happen very early in startup when we can't check config
984
968
# files etc, and also we want to report all failures but not spam the user
1250
1234
# but for now, we haven't optimized...
1251
1235
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
1253
def safe_unicode(unicode_or_utf8_string):
1254
1254
"""Coerce unicode_or_utf8_string into unicode.
1338
1338
def normalizes_filenames():
1339
1339
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1343
1343
return _platform_normalizes_filenames
1349
1349
On platforms where the system normalizes filenames (Mac OSX),
1350
1350
you can access a file by any path which will normalize correctly.
1351
1351
On platforms where the system does not normalize filenames
1352
(Windows, Linux), you have to access a file by its exact path.
1352
(everything else), you have to access a file by its exact path.
1354
1354
Internally, bzr only supports NFC normalization, since that is
1355
1355
the standard for XML documents.
1417
1417
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
1421
1427
def terminal_width():
1422
1428
"""Return terminal width.
1427
1433
- if BZR_COLUMNS is set, returns its value
1428
1434
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1429
1437
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1431
1440
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1435
1444
- get termios.TIOCGWINSZ
1436
1445
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1440
1448
- win32utils.get_console_size() decides,
1441
1449
- 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
1444
1464
# If BZR_COLUMNS is set, take it, user is always right
1450
1470
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1471
if isatty is None or not isatty():
1452
1472
# 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))
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.
1459
1493
return int(os.environ['COLUMNS'])
1460
1494
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
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:
1502
# The width could not be determined.
1471
1506
def _win32_terminal_size(width, height):
1498
1533
_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
1536
def supports_executable():
1527
1537
return sys.platform != "win32"
2028
2042
def send_all(sock, bytes, report_activity=None):
2029
2043
"""Send all bytes on a socket.
2031
2045
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2046
some platforms, and catches EINTR which may be thrown if the send is
2033
2047
interrupted by a signal.
2035
2049
This is preferred to socket.sendall(), because it avoids portability bugs
2036
2050
and provides activity reporting.
2038
2052
:param report_activity: Call this as bytes are read, see
2039
2053
Transport._report_activity
2051
2065
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:
2054
2091
def dereference_path(path):
2055
2092
"""Determine the real path to a file.
2095
2132
base = dirname(bzrlib.__file__)
2096
2133
if getattr(sys, 'frozen', None): # bzr.exe
2097
2134
base = abspath(pathjoin(base, '..', '..'))
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2135
f = file(pathjoin(base, resource_relpath), "rU")
2102
2141
def file_kind_from_stat_mode_thunk(mode):
2103
2142
global file_kind_from_stat_mode
2127
2166
def until_no_eintr(f, *a, **kw):
2128
2167
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2169
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2170
if EINTR does occur. This is typically only true for low-level operations
2132
2171
like os.read. If in any doubt, don't use this.
2189
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2190
def re_compile_checked(re_string, flags=0, where=""):
2151
2191
"""Return a compiled re, or raise a sensible error.
2162
2202
re_obj = re.compile(re_string, flags)
2163
2203
re_obj.search("")
2205
except errors.InvalidPattern, e:
2167
2207
where = ' in ' + where
2168
2208
# despite the name 'error' is a type
2169
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
% (where, re_string, e))
2209
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2173
2213
if sys.platform == "win32":
2263
2303
if sys.platform == 'win32':
2264
2304
def open_file(filename, mode='r', bufsize=-1):
2265
2305
"""This function is used to override the ``open`` builtin.
2267
2307
But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2308
child processes. Deleting or renaming a closed file opened with this
2269
2309
function is not blocking child processes.
2302
2342
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2344
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
