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
45
from tempfile import (
40
from tempfile import mkdtemp
50
43
from bzrlib import (
305
298
running python.exe under cmd.exe return capital C:\\
306
299
running win32 python inside a cygwin shell returns lowercase c:\\
308
drive, path = _nt_splitdrive(path)
301
drive, path = ntpath.splitdrive(path)
309
302
return drive.upper() + path
312
305
def _win32_abspath(path):
313
# Real _nt_abspath doesn't have a problem with a unicode cwd
314
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('\\', '/'))
317
310
def _win98_abspath(path):
328
321
# /path => C:/path
329
322
path = unicode(path)
330
323
# check for absolute path
331
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
332
325
if drive == '' and path[:2] not in('//','\\\\'):
333
326
cwd = os.getcwdu()
334
327
# we cannot simply os.path.join cwd and path
335
328
# because os.path.join('C:','/path') produce '/path'
336
329
# and this is incorrect
337
330
if path[:1] in ('/','\\'):
338
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
340
333
path = cwd + '\\' + path
341
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
344
337
def _win32_realpath(path):
345
# Real _nt_realpath doesn't have a problem with a unicode cwd
346
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('\\', '/'))
349
342
def _win32_pathjoin(*args):
350
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
353
346
def _win32_normpath(path):
354
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
357
350
def _win32_getcwd():
396
389
basename = os.path.basename
397
390
split = os.path.split
398
391
splitext = os.path.splitext
399
# These were already imported into local scope
392
# These were already lazily imported into local scope
400
393
# mkdtemp = tempfile.mkdtemp
401
394
# rmtree = shutil.rmtree
455
448
On my standard US Windows XP, the preferred encoding is
456
449
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
458
453
from bzrlib.trace import mutter
459
454
output_encoding = getattr(sys.stdout, 'encoding', None)
461
456
input_encoding = getattr(sys.stdin, 'encoding', None)
462
457
if not input_encoding:
463
458
output_encoding = get_user_encoding()
464
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
467
463
output_encoding = input_encoding
468
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
465
mutter('encoding stdout as sys.stdin encoding %r',
470
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
471
470
if output_encoding == 'cp0':
472
471
# invalid encoding (cp0 means 'no codepage' on Windows)
473
472
output_encoding = get_user_encoding()
474
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
475
475
' encoding stdout as osutils.get_user_encoding() %r',
512
512
"""True if f is a regular file."""
514
return S_ISREG(os.lstat(f)[ST_MODE])
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
519
519
"""True if f is a symlink."""
521
return S_ISLNK(os.lstat(f)[ST_MODE])
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
933
933
def parent_directories(filename):
934
934
"""Return the list of parent directories, deepest first.
936
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
962
962
# NB: This docstring is just an example, not a doctest, because doctest
963
963
# currently can't cope with the use of lazy imports in this namespace --
966
966
# This currently doesn't report the failure at the time it occurs, because
967
967
# they tend to happen very early in startup when we can't check config
968
968
# files etc, and also we want to report all failures but not spam the user
1133
1133
def relpath(base, path):
1134
"""Return path relative to base, or raise exception.
1134
"""Return path relative to base, or raise PathNotChild exception.
1136
1136
The path may be either an absolute path or a path relative to the
1137
1137
current working directory.
1139
1139
os.path.commonprefix (python2.4) has a bad bug that it works just
1140
1140
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1141
1141
avoids that problem.
1143
NOTE: `base` should not have a trailing slash otherwise you'll get
1144
PathNotChild exceptions regardless of `path`.
1144
1147
if len(base) < MIN_ABS_PATHLENGTH:
1231
1234
# but for now, we haven't optimized...
1232
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)
1234
1253
def safe_unicode(unicode_or_utf8_string):
1235
1254
"""Coerce unicode_or_utf8_string into unicode.
1319
1338
def normalizes_filenames():
1320
1339
"""Return True if this platform normalizes unicode filenames.
1322
Mac OSX does, Windows/Linux do not.
1324
1343
return _platform_normalizes_filenames
1330
1349
On platforms where the system normalizes filenames (Mac OSX),
1331
1350
you can access a file by any path which will normalize correctly.
1332
1351
On platforms where the system does not normalize filenames
1333
(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.
1335
1354
Internally, bzr only supports NFC normalization, since that is
1336
1355
the standard for XML documents.
1398
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
1402
1427
def terminal_width():
1403
1428
"""Return terminal width.
1408
1433
- if BZR_COLUMNS is set, returns its value
1409
1434
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1410
1437
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1412
1440
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1416
1444
- get termios.TIOCGWINSZ
1417
1445
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1421
1448
- win32utils.get_console_size() decides,
1422
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
1425
1464
# If BZR_COLUMNS is set, take it, user is always right
1431
1470
isatty = getattr(sys.stdout, 'isatty', None)
1432
if isatty is None or not isatty():
1471
if isatty is None or not isatty():
1433
1472
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1436
# If COLUMNS is set, take it, the terminal knows better (even inside a
1437
# given terminal, the application can decide to set COLUMNS to a lower
1438
# 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.
1440
1493
return int(os.environ['COLUMNS'])
1441
1494
except (KeyError, ValueError):
1444
width, height = _terminal_size(None, None)
1446
# 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.
1452
1506
def _win32_terminal_size(width, height):
1479
1533
_terminal_size = _ioctl_terminal_size
1482
def _terminal_size_changed(signum, frame):
1483
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1484
width, height = _terminal_size(None, None)
1485
if width is not None:
1486
os.environ['COLUMNS'] = str(width)
1489
_registered_sigwinch = False
1490
def watch_sigwinch():
1491
"""Register for SIGWINCH, once and only once.
1493
Do nothing if the signal module is not available.
1495
global _registered_sigwinch
1496
if not _registered_sigwinch:
1499
if getattr(signal, "SIGWINCH", None) is not None:
1500
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1502
# python doesn't provide signal support, nothing we can do about it
1504
_registered_sigwinch = True
1507
1536
def supports_executable():
1508
1537
return sys.platform != "win32"
2009
2042
def send_all(sock, bytes, report_activity=None):
2010
2043
"""Send all bytes on a socket.
2012
2045
Breaks large blocks in smaller chunks to avoid buffering limitations on
2013
2046
some platforms, and catches EINTR which may be thrown if the send is
2014
2047
interrupted by a signal.
2016
2049
This is preferred to socket.sendall(), because it avoids portability bugs
2017
2050
and provides activity reporting.
2019
2052
:param report_activity: Call this as bytes are read, see
2020
2053
Transport._report_activity
2076
2109
base = dirname(bzrlib.__file__)
2077
2110
if getattr(sys, 'frozen', None): # bzr.exe
2078
2111
base = abspath(pathjoin(base, '..', '..'))
2079
filename = pathjoin(base, resource_relpath)
2080
return open(filename, 'rU').read()
2112
f = file(pathjoin(base, resource_relpath), "rU")
2083
2118
def file_kind_from_stat_mode_thunk(mode):
2084
2119
global file_kind_from_stat_mode
2108
2143
def until_no_eintr(f, *a, **kw):
2109
2144
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2111
2146
WARNING: you must be certain that it is safe to retry the call repeatedly
2112
2147
if EINTR does occur. This is typically only true for low-level operations
2113
2148
like os.read. If in any doubt, don't use this.
2166
@deprecated_function(deprecated_in((2, 2, 0)))
2131
2167
def re_compile_checked(re_string, flags=0, where=""):
2132
2168
"""Return a compiled re, or raise a sensible error.
2143
2179
re_obj = re.compile(re_string, flags)
2144
2180
re_obj.search("")
2182
except errors.InvalidPattern, e:
2148
2184
where = ' in ' + where
2149
2185
# despite the name 'error' is a type
2150
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2151
% (where, re_string, e))
2186
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2154
2190
if sys.platform == "win32":
2244
2280
if sys.platform == 'win32':
2245
2281
def open_file(filename, mode='r', bufsize=-1):
2246
2282
"""This function is used to override the ``open`` builtin.
2248
2284
But it uses O_NOINHERIT flag so the file handle is not inherited by
2249
2285
child processes. Deleting or renaming a closed file opened with this
2250
2286
function is not blocking child processes.
2283
2319
return os.fdopen(os.open(filename, flags), mode, bufsize)
2285
2321
open_file = open
2324
def getuser_unicode():
2325
"""Return the username as unicode.
2328
user_encoding = get_user_encoding()
2329
username = getpass.getuser().decode(user_encoding)
2330
except UnicodeDecodeError:
2331
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
