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
17
from __future__ import absolute_import
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
27
from .lazy_import import lazy_import
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
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,
35
# We need to import both shutil and rmtree as we export the later on posix
36
# and need the former on windows
38
from shutil import rmtree
41
# We need to import both tempfile and mkdtemp as we export the later on posix
42
# and need the former on windows
44
from tempfile import mkdtemp
43
from tempfile import (
52
from breezy.i18n import gettext
56
from bzrlib.symbol_versioning import (
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
if sys.version_info < (2, 5):
64
import md5 as _mod_md5
66
import sha as _mod_sha
76
from bzrlib import symbol_versioning
73
79
# Cross platform wall-clock time functionality with decent resolution.
90
96
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
93
class UnsupportedTimezoneFormat(errors.BzrError):
95
_fmt = ('Unsupported timezone format "%(timezone)s", '
96
'options are "utc", "original", "local".')
98
def __init__(self, timezone):
99
self.timezone = timezone
102
99
def get_unicode_argv():
106
101
user_encoding = get_user_encoding()
107
102
return [a.decode(user_encoding) for a in sys.argv[1:]]
108
103
except UnicodeDecodeError:
109
raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
"application locale.").format(a, user_encoding))
104
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
113
108
def make_readonly(filename):
114
109
"""Make a filename read-only."""
115
110
mod = os.lstat(filename).st_mode
116
111
if not stat.S_ISLNK(mod):
118
chmod_if_possible(filename, mod)
113
os.chmod(filename, mod)
121
116
def make_writable(filename):
122
117
mod = os.lstat(filename).st_mode
123
118
if not stat.S_ISLNK(mod):
125
chmod_if_possible(filename, mod)
128
def chmod_if_possible(filename, mode):
129
# Set file mode if that can be safely done.
130
# Sometimes even on unix the filesystem won't allow it - see
131
# https://bugs.launchpad.net/bzr/+bug/606537
133
# It is probably faster to just do the chmod, rather than
134
# doing a stat, and then trying to compare
135
os.chmod(filename, mode)
136
except (IOError, OSError) as e:
137
# Permission/access denied seems to commonly happen on smbfs; there's
138
# probably no point warning about it.
139
# <https://bugs.launchpad.net/bzr/+bug/606537>
140
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
141
trace.mutter("ignore error on chmod of %r: %r" % (
120
os.chmod(filename, mod)
147
123
def minimum_path_selection(paths):
259
232
file_existed = False
261
234
rename_func(new, tmp_name)
262
except (errors.NoSuchFile,) as e:
235
except (errors.NoSuchFile,), e:
265
238
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
266
239
# function raises an IOError with errno is None when a rename fails.
267
240
# This then gets caught here.
268
241
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
270
except Exception as e:
271
244
if (getattr(e, 'errno', None) is None
272
245
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
275
248
file_existed = True
279
# This may throw an exception, in which case success will
281
rename_func(old, new)
283
except (IOError, OSError) as e:
284
# source and target may be aliases of each other (e.g. on a
285
# case-insensitive filesystem), so we may have accidentally renamed
286
# source by when we tried to rename target
287
if (file_existed and e.errno in (None, errno.ENOENT)
288
and old.lower() == new.lower()):
289
# source and target are the same file on a case-insensitive
290
# filesystem, so we don't generate an exception
254
# This may throw an exception, in which case success will
256
rename_func(old, new)
258
except (IOError, OSError), e:
259
# source and target may be aliases of each other (e.g. on a
260
# case-insensitive filesystem), so we may have accidentally renamed
261
# source by when we tried to rename target
262
failure_exc = sys.exc_info()
263
if (file_existed and e.errno in (None, errno.ENOENT)
264
and old.lower() == new.lower()):
265
# source and target are the same file on a case-insensitive
266
# filesystem, so we don't generate an exception
296
270
# If the file used to exist, rename it back into place
299
273
unlink_func(tmp_name)
301
275
rename_func(tmp_name, new)
276
if failure_exc is not None:
277
raise failure_exc[0], failure_exc[1], failure_exc[2]
304
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
305
281
# choke on a Unicode string containing a relative path if
306
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
308
285
def _posix_abspath(path):
309
286
# jam 20060426 rather than encoding to fsencoding
310
287
# copy posixpath.abspath, but use os.getcwdu instead
311
288
if not posixpath.isabs(path):
312
289
path = posixpath.join(getcwd(), path)
313
return _posix_normpath(path)
290
return posixpath.normpath(path)
316
293
def _posix_realpath(path):
317
294
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
320
def _posix_normpath(path):
321
path = posixpath.normpath(path)
322
# Bug 861008: posixpath.normpath() returns a path normalized according to
323
# the POSIX standard, which stipulates (for compatibility reasons) that two
324
# leading slashes must not be simplified to one, and only if there are 3 or
325
# more should they be simplified as one. So we treat the leading 2 slashes
326
# as a special case here by simply removing the first slash, as we consider
327
# that breaking POSIX compatibility for this obscure feature is acceptable.
328
# This is not a paranoid precaution, as we notably get paths like this when
329
# the repo is hosted at the root of the filesystem, i.e. in "/".
330
if path.startswith('//'):
335
def _posix_path_from_environ(key):
336
"""Get unicode path from `key` in environment or None if not present
338
Note that posix systems use arbitrary byte strings for filesystem objects,
339
so a path that raises BadFilenameEncoding here may still be accessible.
341
val = os.environ.get(key, None)
342
if PY3 or val is None:
345
return val.decode(_fs_enc)
346
except UnicodeDecodeError:
347
# GZ 2011-12-12:Ideally want to include `key` in the exception message
348
raise errors.BadFilenameEncoding(val, _fs_enc)
351
def _posix_get_home_dir():
352
"""Get the home directory of the current user as a unicode path"""
353
path = posixpath.expanduser("~")
355
return path.decode(_fs_enc)
356
except AttributeError:
358
except UnicodeDecodeError:
359
raise errors.BadFilenameEncoding(path, _fs_enc)
362
def _posix_getuser_unicode():
363
"""Get username from environment or password database as unicode"""
364
name = getpass.getuser()
367
user_encoding = get_user_encoding()
369
return name.decode(user_encoding)
370
except UnicodeDecodeError:
371
raise errors.BzrError("Encoding of username %r is unsupported by %s "
372
"application locale." % (name, user_encoding))
375
297
def _win32_fixdrive(path):
376
298
"""Force drive letters to be consistent.
381
303
running python.exe under cmd.exe return capital C:\\
382
304
running win32 python inside a cygwin shell returns lowercase c:\\
384
drive, path = ntpath.splitdrive(path)
306
drive, path = _nt_splitdrive(path)
385
307
return drive.upper() + path
388
310
def _win32_abspath(path):
389
# Real ntpath.abspath doesn't have a problem with a unicode cwd
390
return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
315
def _win98_abspath(path):
316
"""Return the absolute version of a path.
317
Windows 98 safe implementation (python reimplementation
318
of Win32 API function GetFullPathNameW)
323
# \\HOST\path => //HOST/path
324
# //HOST/path => //HOST/path
325
# path => C:/cwd/path
328
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
330
if drive == '' and path[:2] not in('//','\\\\'):
332
# we cannot simply os.path.join cwd and path
333
# because os.path.join('C:','/path') produce '/path'
334
# and this is incorrect
335
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
338
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
393
342
def _win32_realpath(path):
394
# Real ntpath.realpath doesn't have a problem with a unicode cwd
395
return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
398
347
def _win32_pathjoin(*args):
399
return ntpath.join(*args).replace('\\', '/')
348
return _nt_join(*args).replace('\\', '/')
402
351
def _win32_normpath(path):
403
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
406
355
def _win32_getcwd():
407
return _win32_fixdrive(_getcwd().replace('\\', '/'))
356
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
410
359
def _win32_mkdtemp(*args, **kwargs):
411
360
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
414
371
def _win32_rename(old, new):
415
372
"""We expect to be able to atomically replace 'new' with old.
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)
432
399
def _mac_getcwd():
433
return unicodedata.normalize('NFC', _getcwd())
436
def _rename_wrap_exception(rename_func):
437
"""Adds extra information to any exceptions that come from rename().
439
The exception has an updated message and 'old_filename' and 'new_filename'
443
def _rename_wrapper(old, new):
445
rename_func(old, new)
447
detailed_error = OSError(e.errno, e.strerror +
448
" [occurred when renaming '%s' to '%s']" %
450
detailed_error.old_filename = old
451
detailed_error.new_filename = new
454
return _rename_wrapper
457
if sys.version_info > (3,):
463
# Default rename wraps os.rename()
464
rename = _rename_wrap_exception(os.rename)
400
return unicodedata.normalize('NFC', os.getcwdu())
466
403
# Default is to just use the python builtins, but these can be rebound on
467
404
# particular platforms.
468
405
abspath = _posix_abspath
469
406
realpath = _posix_realpath
470
407
pathjoin = os.path.join
471
normpath = _posix_normpath
472
path_from_environ = _posix_path_from_environ
473
_get_home_dir = _posix_get_home_dir
474
getuser_unicode = _posix_getuser_unicode
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
476
411
dirname = os.path.dirname
477
412
basename = os.path.basename
478
413
split = os.path.split
479
414
splitext = os.path.splitext
480
# These were already lazily imported into local scope
415
# These were already imported into local scope
481
416
# mkdtemp = tempfile.mkdtemp
482
417
# rmtree = shutil.rmtree
490
419
MIN_ABS_PATHLENGTH = 1
493
422
if sys.platform == 'win32':
494
abspath = _win32_abspath
423
if win32utils.winver == 'Windows 98':
424
abspath = _win98_abspath
426
abspath = _win32_abspath
495
427
realpath = _win32_realpath
496
428
pathjoin = _win32_pathjoin
497
429
normpath = _win32_normpath
498
430
getcwd = _win32_getcwd
499
431
mkdtemp = _win32_mkdtemp
500
rename = _rename_wrap_exception(_win32_rename)
502
from . import _walkdirs_win32
506
lstat = _walkdirs_win32.lstat
507
fstat = _walkdirs_win32.fstat
508
wrap_stat = _walkdirs_win32.wrap_stat
432
rename = _win32_rename
510
434
MIN_ABS_PATHLENGTH = 3
550
471
On my standard US Windows XP, the preferred encoding is
551
472
cp1252, but the console is cp437
553
:param trace: If True trace the selected encoding via mutter().
555
from .trace import mutter
474
from bzrlib.trace import mutter
556
475
output_encoding = getattr(sys.stdout, 'encoding', None)
557
476
if not output_encoding:
558
477
input_encoding = getattr(sys.stdin, 'encoding', None)
559
478
if not input_encoding:
560
479
output_encoding = get_user_encoding()
562
mutter('encoding stdout as osutils.get_user_encoding() %r',
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
565
483
output_encoding = input_encoding
567
mutter('encoding stdout as sys.stdin encoding %r',
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
571
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
572
487
if output_encoding == 'cp0':
573
488
# invalid encoding (cp0 means 'no codepage' on Windows)
574
489
output_encoding = get_user_encoding()
576
mutter('cp0 is invalid encoding.'
490
mutter('cp0 is invalid encoding.'
577
491
' encoding stdout as osutils.get_user_encoding() %r',
581
495
codecs.lookup(output_encoding)
582
496
except LookupError:
583
sys.stderr.write('brz: warning:'
497
sys.stderr.write('bzr: warning:'
584
498
' unknown terminal encoding %s.\n'
585
499
' Using encoding %s instead.\n'
586
500
% (output_encoding, get_user_encoding())
984
882
"""Return size of given open file."""
985
return os.fstat(f.fileno())[stat.ST_SIZE]
988
# Alias os.urandom to support platforms (which?) without /dev/urandom and
989
# override if it doesn't work. Avoid checking on windows where there is
990
# significant initialisation cost that can be avoided for some bzr calls.
992
rand_bytes = os.urandom
994
if rand_bytes.__module__ != "nt":
883
return os.fstat(f.fileno())[ST_SIZE]
886
# Define rand_bytes based on platform.
888
# Python 2.4 and later have os.urandom,
889
# but it doesn't work on some arches
891
rand_bytes = os.urandom
892
except (NotImplementedError, AttributeError):
893
# If python doesn't have os.urandom, or it doesn't work,
894
# then try to first pull random data from /dev/urandom
997
except NotImplementedError:
896
rand_bytes = file('/dev/urandom', 'rb').read
897
# Otherwise, use this hack as a last resort
898
except (IOError, OSError):
998
899
# not well seeded, but better than nothing
999
900
def rand_bytes(n):
1072
970
implementation should be loaded instead::
1075
>>> import breezy._fictional_extension_pyx
973
>>> import bzrlib._fictional_extension_pyx
1076
974
>>> except ImportError, e:
1077
>>> breezy.osutils.failed_to_load_extension(e)
1078
>>> import breezy._fictional_extension_py
975
>>> bzrlib.osutils.failed_to_load_extension(e)
976
>>> import bzrlib._fictional_extension_py
1080
978
# NB: This docstring is just an example, not a doctest, because doctest
1081
979
# currently can't cope with the use of lazy imports in this namespace --
1084
982
# This currently doesn't report the failure at the time it occurs, because
1085
983
# they tend to happen very early in startup when we can't check config
1086
984
# files etc, and also we want to report all failures but not spam the user
1087
985
# with 10 warnings.
986
from bzrlib import trace
1088
987
exception_str = str(exception)
1089
988
if exception_str not in _extension_load_failures:
1090
989
trace.mutter("failed to load compiled extension: %s" % exception_str)
1094
993
def report_extension_load_failures():
1095
994
if not _extension_load_failures:
1097
if config.GlobalConfig().suppress_warning('missing_extensions'):
996
from bzrlib.config import GlobalConfig
997
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1099
999
# the warnings framework should by default show this only once
1100
from .trace import warning
1000
from bzrlib.trace import warning
1102
"brz: warning: some compiled extensions could not be loaded; "
1103
"see ``brz help missing-extensions``")
1002
"bzr: warning: some compiled extensions could not be loaded; "
1003
"see <https://answers.launchpad.net/bzr/+faq/703>")
1104
1004
# we no longer show the specific missing extensions here, because it makes
1105
1005
# the message too long and scary - see
1106
1006
# https://bugs.launchpad.net/bzr/+bug/430529
1110
from ._chunks_to_lines_pyx import chunks_to_lines
1111
except ImportError as e:
1010
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
except ImportError, e:
1112
1012
failed_to_load_extension(e)
1113
from ._chunks_to_lines_py import chunks_to_lines
1013
from bzrlib._chunks_to_lines_py import chunks_to_lines
1116
1016
def split_lines(s):
1117
1017
"""Split s into lines, but without removing the newline characters."""
1118
1018
# Trivially convert a fulltext into a 'chunked' representation, and let
1119
1019
# chunks_to_lines do the heavy lifting.
1120
if isinstance(s, bytes):
1020
if isinstance(s, str):
1121
1021
# chunks_to_lines only supports 8-bit strings
1122
1022
return chunks_to_lines([s])
1150
1049
os.link(src, dest)
1151
except (OSError, IOError) as e:
1050
except (OSError, IOError), e:
1152
1051
if e.errno != errno.EXDEV:
1154
1053
shutil.copyfile(src, dest)
1157
1056
def delete_any(path):
1158
"""Delete a file, symlink or directory.
1057
"""Delete a file, symlink or directory.
1160
1059
Will delete even if readonly.
1163
1062
_delete_file_or_dir(path)
1164
except (OSError, IOError) as e:
1063
except (OSError, IOError), e:
1165
1064
if e.errno in (errno.EPERM, errno.EACCES):
1166
1065
# make writable and try again
1351
1250
# but for now, we haven't optimized...
1352
1251
return [canonical_relpath(base, p) for p in paths]
1355
def decode_filename(filename):
1356
"""Decode the filename using the filesystem encoding
1358
If it is unicode, it is returned.
1359
Otherwise it is decoded from the the filesystem's encoding. If decoding
1360
fails, a errors.BadFilenameEncoding exception is raised.
1362
if isinstance(filename, text_type):
1365
return filename.decode(_fs_enc)
1366
except UnicodeDecodeError:
1367
raise errors.BadFilenameEncoding(filename, _fs_enc)
1370
1253
def safe_unicode(unicode_or_utf8_string):
1371
1254
"""Coerce unicode_or_utf8_string into unicode.
1401
1284
return unicode_or_utf8_string.encode('utf-8')
1404
def safe_revision_id(unicode_or_utf8_string):
1287
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1288
' Revision id generators should be creating utf8'
1292
def safe_revision_id(unicode_or_utf8_string, warn=True):
1405
1293
"""Revision ids should now be utf8, but at one point they were unicode.
1407
1295
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1297
:param warn: Functions that are sanitizing user data can set warn=False
1409
1298
:return: None or a utf8 revision id.
1411
1300
if (unicode_or_utf8_string is None
1412
or unicode_or_utf8_string.__class__ == bytes):
1301
or unicode_or_utf8_string.__class__ == str):
1413
1302
return unicode_or_utf8_string
1414
raise TypeError('Unicode revision ids are no longer supported. '
1415
'Revision id generators should be creating utf8 revision '
1419
def safe_file_id(unicode_or_utf8_string):
1304
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1306
return cache_utf8.encode(unicode_or_utf8_string)
1309
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1310
' generators should be creating utf8 file ids.')
1313
def safe_file_id(unicode_or_utf8_string, warn=True):
1420
1314
"""File ids should now be utf8, but at one point they were unicode.
1422
1316
This is the same as safe_utf8, except it uses the cached encode functions
1461
1358
can be accessed by that path.
1464
if isinstance(path, bytes):
1465
path = path.decode(sys.getfilesystemencoding())
1466
return unicodedata.normalize('NFC', path), True
1361
return unicodedata.normalize('NFC', unicode(path)), True
1469
1364
def _inaccessible_normalized_filename(path):
1470
1365
__doc__ = _accessible_normalized_filename.__doc__
1472
if isinstance(path, bytes):
1473
path = path.decode(sys.getfilesystemencoding())
1474
normalized = unicodedata.normalize('NFC', path)
1367
normalized = unicodedata.normalize('NFC', unicode(path))
1475
1368
return normalized, normalized == path
1537
1424
None is returned if the width can't established precisely.
1540
- if BRZ_COLUMNS is set, returns its value
1427
- if BZR_COLUMNS is set, returns its value
1541
1428
- if there is no controlling terminal, returns None
1542
- query the OS, if the queried size has changed since the last query,
1544
1429
- if COLUMNS is set, returns its value,
1545
- if the OS has a value (even though it's never changed), return its value.
1547
1431
From there, we need to query the OS to get the size of the controlling
1550
On Unices we query the OS by:
1551
1435
- get termios.TIOCGWINSZ
1552
1436
- if an error occurs or a negative value is obtained, returns None
1554
On Windows we query the OS by:
1555
1440
- win32utils.get_console_size() decides,
1556
1441
- returns None on error (provided default value)
1558
# Note to implementors: if changing the rules for determining the width,
1559
# make sure you've considered the behaviour in these cases:
1560
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1561
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1563
# - (add more interesting cases here, if you find any)
1564
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1565
# but we don't want to register a signal handler because it is impossible
1566
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1567
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1568
# time so we can notice if the reported size has changed, which should have
1571
# If BRZ_COLUMNS is set, take it, user is always right
1572
# Except if they specified 0 in which case, impose no limit here
1444
# If BZR_COLUMNS is set, take it, user is always right
1574
width = int(os.environ['BRZ_COLUMNS'])
1446
return int(os.environ['BZR_COLUMNS'])
1575
1447
except (KeyError, ValueError):
1577
if width is not None:
1583
1450
isatty = getattr(sys.stdout, 'isatty', None)
1584
if isatty is None or not isatty():
1585
# Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1451
if isatty is None or not isatty():
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1589
width, height = os_size = _terminal_size(None, None)
1590
global _first_terminal_size, _terminal_size_state
1591
if _terminal_size_state == 'no_data':
1592
_first_terminal_size = os_size
1593
_terminal_size_state = 'unchanged'
1594
elif (_terminal_size_state == 'unchanged' and
1595
_first_terminal_size != os_size):
1596
_terminal_size_state = 'changed'
1598
# If the OS claims to know how wide the terminal is, and this value has
1599
# ever changed, use that.
1600
if _terminal_size_state == 'changed':
1601
if width is not None and width > 0:
1604
# If COLUMNS is set, use it.
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))
1606
1459
return int(os.environ['COLUMNS'])
1607
1460
except (KeyError, ValueError):
1610
# Finally, use an unchanged size from the OS, if we have one.
1611
if _terminal_size_state == 'unchanged':
1612
if width is not None and width > 0:
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1615
# The width could not be determined.
1619
1471
def _win32_terminal_size(width, height):
1646
1498
_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
1649
1526
def supports_executable():
1650
1527
return sys.platform != "win32"
1835
1712
global _selected_dir_reader
1836
1713
if _selected_dir_reader is None:
1837
if sys.platform == "win32":
1714
fs_encoding = _fs_enc.upper()
1715
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
# Win98 doesn't have unicode apis like FindFirstFileW
1717
# TODO: We possibly could support Win98 by falling back to the
1718
# original FindFirstFile, and using TCHAR instead of WCHAR,
1719
# but that gets a bit tricky, and requires custom compiling
1839
from ._walkdirs_win32 import Win32ReadDir
1722
from bzrlib._walkdirs_win32 import Win32ReadDir
1840
1723
_selected_dir_reader = Win32ReadDir()
1841
1724
except ImportError:
1843
elif _fs_enc in ('utf-8', 'ascii'):
1726
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
# ANSI_X3.4-1968 is a form of ASCII
1845
from ._readdir_pyx import UTF8DirReader
1729
from bzrlib._readdir_pyx import UTF8DirReader
1846
1730
_selected_dir_reader = UTF8DirReader()
1847
except ImportError as e:
1731
except ImportError, e:
1848
1732
failed_to_load_extension(e)
1993
1874
This can be used to sort paths in the same way that walkdirs does.
1995
return (dirname(path), path)
1876
return (dirname(path) , path)
1998
1879
def compare_paths_prefix_order(path_a, path_b):
1999
1880
"""Compare path_a and path_b to generate the same order walkdirs uses."""
2000
1881
key_a = path_prefix_key(path_a)
2001
1882
key_b = path_prefix_key(path_b)
2002
return (key_a > key_b) - (key_a < key_b)
1883
return cmp(key_a, key_b)
2005
1886
_cached_user_encoding = None
2008
def get_user_encoding():
1889
def get_user_encoding(use_cache=True):
2009
1890
"""Find out what the preferred user encoding is.
2011
1892
This is generally the encoding that is used for command line parameters
2012
1893
and file contents. This may be different from the terminal encoding
2013
1894
or the filesystem encoding.
1896
:param use_cache: Enable cache for detected encoding.
1897
(This parameter is turned on by default,
1898
and required only for selftesting)
2015
1900
:return: A string defining the preferred user encoding
2017
1902
global _cached_user_encoding
2018
if _cached_user_encoding is not None:
1903
if _cached_user_encoding is not None and use_cache:
2019
1904
return _cached_user_encoding
2021
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2022
# Use the existing locale settings and call nl_langinfo directly
2023
# rather than going through getpreferredencoding. This avoids
2024
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2025
# possibility of the setlocale call throwing an error.
2026
user_encoding = locale.nl_langinfo(locale.CODESET)
1906
if sys.platform == 'darwin':
1907
# python locale.getpreferredencoding() always return
1908
# 'mac-roman' on darwin. That's a lie.
1909
sys.platform = 'posix'
1911
if os.environ.get('LANG', None) is None:
1912
# If LANG is not set, we end up with 'ascii', which is bad
1913
# ('mac-roman' is more than ascii), so we set a default which
1914
# will give us UTF-8 (which appears to work in all cases on
1915
# OSX). Users are still free to override LANG of course, as
1916
# long as it give us something meaningful. This work-around
1917
# *may* not be needed with python 3k and/or OSX 10.5, but will
1918
# work with them too -- vila 20080908
1919
os.environ['LANG'] = 'en_US.UTF-8'
1922
sys.platform = 'darwin'
2028
# GZ 2011-12-19: On windows could call GetACP directly instead.
2029
user_encoding = locale.getpreferredencoding(False)
2032
user_encoding = codecs.lookup(user_encoding).name
2034
if user_encoding not in ("", "cp0"):
2035
sys.stderr.write('brz: warning:'
1927
user_encoding = locale.getpreferredencoding()
1928
except locale.Error, e:
1929
sys.stderr.write('bzr: warning: %s\n'
1930
' Could not determine what text encoding to use.\n'
1931
' This error usually means your Python interpreter\n'
1932
' doesn\'t support the locale set by $LANG (%s)\n'
1933
" Continuing with ascii encoding.\n"
1934
% (e, os.environ.get('LANG')))
1935
user_encoding = 'ascii'
1937
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
# treat that as ASCII, and not support printing unicode characters to the
1941
# For python scripts run under vim, we get '', so also treat that as ASCII
1942
if user_encoding in (None, 'cp0', ''):
1943
user_encoding = 'ascii'
1947
codecs.lookup(user_encoding)
1949
sys.stderr.write('bzr: warning:'
2036
1950
' unknown encoding %s.'
2037
1951
' Continuing with ascii encoding.\n'
2038
1952
% user_encoding
2040
user_encoding = 'ascii'
2042
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2043
if user_encoding == 'ascii':
2044
if sys.platform == 'darwin':
2045
# OSX is special-cased in Python to have a UTF-8 filesystem
2046
# encoding and previously had LANG set here if not present.
2047
user_encoding = 'utf-8'
2048
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2049
# for some other posix platforms as well.
2051
_cached_user_encoding = user_encoding
1954
user_encoding = 'ascii'
1957
_cached_user_encoding = user_encoding
2052
1959
return user_encoding
2055
def get_diff_header_encoding():
2056
return get_terminal_encoding()
2059
1962
def get_host_name():
2060
1963
"""Return the current unicode host name.
2093
1987
empty string rather than raise an error), and repeats the recv if
2094
1988
interrupted by a signal.
2098
data = sock.recv(max_read_size)
2099
except socket.error as e:
1992
bytes = sock.recv(max_read_size)
1993
except socket.error, e:
2100
1994
eno = e.args[0]
2101
if eno in _end_of_stream_errors:
1995
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2102
1996
# The connection was closed by the other side. Callers expect
2103
1997
# an empty string to signal end-of-stream.
2105
1999
elif eno == errno.EINTR:
2106
2000
# Retry the interrupted recv.
2110
2004
if report_activity is not None:
2111
report_activity(len(data), 'read')
2005
report_activity(len(bytes), 'read')
2115
2009
def recv_all(socket, count):
2134
2028
def send_all(sock, bytes, report_activity=None):
2135
2029
"""Send all bytes on a socket.
2137
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2138
2032
some platforms, and catches EINTR which may be thrown if the send is
2139
2033
interrupted by a signal.
2141
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2142
2036
and provides activity reporting.
2144
2038
:param report_activity: Call this as bytes are read, see
2145
2039
Transport._report_activity
2148
2042
byte_count = len(bytes)
2149
view = memoryview(bytes)
2150
2043
while sent_total < byte_count:
2152
sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2153
except (socket.error, IOError) as e:
2154
if e.args[0] in _end_of_stream_errors:
2155
raise errors.ConnectionReset(
2156
"Error trying to write to socket", e)
2045
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
except socket.error, e:
2157
2047
if e.args[0] != errno.EINTR:
2161
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2163
2050
sent_total += sent
2164
if report_activity is not None:
2165
report_activity(sent, 'write')
2168
def connect_socket(address):
2169
# Slight variation of the socket.create_connection() function (provided by
2170
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2171
# provide it for previous python versions. Also, we don't use the timeout
2172
# parameter (provided by the python implementation) so we don't implement
2174
err = socket.error('getaddrinfo returns an empty list')
2175
host, port = address
2176
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2177
af, socktype, proto, canonname, sa = res
2180
sock = socket.socket(af, socktype, proto)
2184
except socket.error as e:
2186
# 'err' is now the most recent error
2187
if sock is not None:
2051
report_activity(sent, 'write')
2192
2054
def dereference_path(path):
2220
2082
If and when pkg_resources becomes a standard library, this routine
2221
2083
can delegate to it.
2223
# Check package name is within breezy
2224
if package == "breezy":
2085
# Check package name is within bzrlib
2086
if package == "bzrlib":
2225
2087
resource_relpath = resource_name
2226
elif package.startswith("breezy."):
2227
package = package[len("breezy."):].replace('.', os.sep)
2088
elif package.startswith("bzrlib."):
2089
package = package[len("bzrlib."):].replace('.', os.sep)
2228
2090
resource_relpath = pathjoin(package, resource_name)
2230
raise errors.BzrError('resource package %s not in breezy' % package)
2092
raise errors.BzrError('resource package %s not in bzrlib' % package)
2232
2094
# Map the resource to a file and read its contents
2233
base = dirname(breezy.__file__)
2095
base = dirname(bzrlib.__file__)
2234
2096
if getattr(sys, 'frozen', None): # bzr.exe
2235
2097
base = abspath(pathjoin(base, '..', '..'))
2236
with open(pathjoin(base, resource_relpath), "rt") as f:
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2239
2102
def file_kind_from_stat_mode_thunk(mode):
2240
2103
global file_kind_from_stat_mode
2241
2104
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2243
from ._readdir_pyx import UTF8DirReader
2106
from bzrlib._readdir_pyx import UTF8DirReader
2244
2107
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2245
except ImportError as e:
2108
except ImportError, e:
2246
2109
# This is one time where we won't warn that an extension failed to
2247
2110
# load. The extension is never available on Windows anyway.
2248
from ._readdir_py import (
2111
from bzrlib._readdir_py import (
2249
2112
_kind_from_mode as file_kind_from_stat_mode
2251
2114
return file_kind_from_stat_mode(mode)
2252
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2254
def file_stat(f, _lstat=os.lstat):
2118
def file_kind(f, _lstat=os.lstat):
2258
except OSError as e:
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2259
2122
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2260
2123
raise errors.NoSuchFile(f)
2263
def file_kind(f, _lstat=os.lstat):
2264
stat_value = file_stat(f, _lstat)
2265
return file_kind_from_stat_mode(stat_value.st_mode)
2267
2127
def until_no_eintr(f, *a, **kw):
2268
2128
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2270
2130
WARNING: you must be certain that it is safe to retry the call repeatedly
2271
2131
if EINTR does occur. This is typically only true for low-level operations
2272
2132
like os.read. If in any doubt, don't use this.
2274
2134
Keep in mind that this is not a complete solution to EINTR. There is
2275
2135
probably code in the Python standard library and other dependencies that
2276
2136
may encounter EINTR if a signal arrives (and there is signal handler for
2277
that signal). So this function can reduce the impact for IO that breezy
2137
that signal). So this function can reduce the impact for IO that bzrlib
2278
2138
directly controls, but it is not a complete solution.
2280
2140
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2283
2143
return f(*a, **kw)
2284
except (IOError, OSError) as e:
2144
except (IOError, OSError), e:
2285
2145
if e.errno == errno.EINTR:
2150
def re_compile_checked(re_string, flags=0, where=""):
2151
"""Return a compiled re, or raise a sensible error.
2153
This should only be used when compiling user-supplied REs.
2155
:param re_string: Text form of regular expression.
2156
:param flags: eg re.IGNORECASE
2157
:param where: Message explaining to the user the context where
2158
it occurred, eg 'log search filter'.
2160
# from https://bugs.launchpad.net/bzr/+bug/251352
2162
re_obj = re.compile(re_string, flags)
2167
where = ' in ' + where
2168
# despite the name 'error' is a type
2169
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
% (where, re_string, e))
2290
2173
if sys.platform == "win32":
2293
2176
return msvcrt.getch()
2298
2181
fd = sys.stdin.fileno()
2299
2182
settings = termios.tcgetattr(fd)
2304
2187
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2307
if sys.platform.startswith('linux'):
2191
if sys.platform == 'linux2':
2308
2192
def _local_concurrency():
2310
return os.sysconf('SC_NPROCESSORS_ONLN')
2311
except (ValueError, OSError, AttributeError):
2194
prefix = 'processor'
2195
for line in file('/proc/cpuinfo', 'rb'):
2196
if line.startswith(prefix):
2197
concurrency = int(line[line.find(':')+1:]) + 1
2313
2199
elif sys.platform == 'darwin':
2314
2200
def _local_concurrency():
2315
2201
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2316
2202
stdout=subprocess.PIPE).communicate()[0]
2317
elif "bsd" in sys.platform:
2203
elif sys.platform[0:7] == 'freebsd':
2318
2204
def _local_concurrency():
2319
2205
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2320
2206
stdout=subprocess.PIPE).communicate()[0]
2421
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
2423
2304
open_file = open
2426
def available_backup_name(base, exists):
2427
"""Find a non-existing backup file name.
2429
This will *not* create anything, this only return a 'free' entry. This
2430
should be used for checking names in a directory below a locked
2431
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2432
Leap) and generally discouraged.
2434
:param base: The base name.
2436
:param exists: A callable returning True if the path parameter exists.
2439
name = "%s.~%d~" % (base, counter)
2442
name = "%s.~%d~" % (base, counter)
2446
def set_fd_cloexec(fd):
2447
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2448
support for this is not available.
2452
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2453
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2454
except (ImportError, AttributeError):
2455
# Either the fcntl module or specific constants are not present
2459
def find_executable_on_path(name):
2460
"""Finds an executable on the PATH.
2462
On Windows, this will try to append each extension in the PATHEXT
2463
environment variable to the name, if it cannot be found with the name
2466
:param name: The base name of the executable.
2467
:return: The path to the executable found or None.
2469
if sys.platform == 'win32':
2470
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2471
exts = [ext.lower() for ext in exts]
2472
base, ext = os.path.splitext(name)
2474
if ext.lower() not in exts:
2480
path = os.environ.get('PATH')
2481
if path is not None:
2482
path = path.split(os.pathsep)
2485
f = os.path.join(d, name) + ext
2486
if os.access(f, os.X_OK):
2488
if sys.platform == 'win32':
2489
app_path = win32utils.get_app_path(name)
2490
if app_path != name:
2495
def _posix_is_local_pid_dead(pid):
2496
"""True if pid doesn't correspond to live process on this machine"""
2498
# Special meaning of unix kill: just check if it's there.
2500
except OSError as e:
2501
if e.errno == errno.ESRCH:
2502
# On this machine, and really not found: as sure as we can be
2505
elif e.errno == errno.EPERM:
2506
# exists, though not ours
2509
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2510
# Don't really know.
2513
# Exists and our process: not dead.
2516
if sys.platform == "win32":
2517
is_local_pid_dead = win32utils.is_local_pid_dead
2519
is_local_pid_dead = _posix_is_local_pid_dead
2521
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2522
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2523
if getattr(errno, name, None) is not None]
2526
def fdatasync(fileno):
2527
"""Flush file contents to disk if possible.
2529
:param fileno: Integer OS file handle.
2530
:raises TransportNotPossible: If flushing to disk is not possible.
2532
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2536
except IOError as e:
2537
# See bug #1075108, on some platforms fdatasync exists, but can
2538
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2539
# and reduce the chance of corruption-on-powerloss situations. It
2540
# is not a mandatory call, so it is ok to suppress failures.
2541
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2542
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2546
def ensure_empty_directory_exists(path, exception_class):
2547
"""Make sure a local directory exists and is empty.
2549
If it does not exist, it is created. If it exists and is not empty, an
2550
instance of exception_class is raised.
2554
except OSError as e:
2555
if e.errno != errno.EEXIST:
2557
if os.listdir(path) != []:
2558
raise exception_class(path)
2561
def is_environment_error(evalue):
2562
"""True if exception instance is due to a process environment issue
2564
This includes OSError and IOError, but also other errors that come from
2565
the operating system or core libraries but are not subclasses of those.
2567
if isinstance(evalue, (EnvironmentError, select.error)):
2569
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
