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
25
from bzrlib.lazy_import import lazy_import
27
from .lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
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,
30
from datetime import timedelta
36
# We need to import both shutil and rmtree as we export the later on posix
37
# and need the former on windows
39
from shutil import rmtree
42
# We need to import both tempfile and mkdtemp as we export the later on posix
43
# and need the former on windows
43
from tempfile import (
45
from tempfile import mkdtemp
55
from breezy.i18n import gettext
56
from bzrlib.symbol_versioning import (
62
from .symbol_versioning import (
57
64
deprecated_function,
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
67
warn as warn_deprecated,
77
from . import symbol_versioning, _fs_enc
79
80
# Cross platform wall-clock time functionality with decent resolution.
99
100
def get_unicode_argv():
101
104
user_encoding = get_user_encoding()
102
105
return [a.decode(user_encoding) for a in sys.argv[1:]]
103
106
except UnicodeDecodeError:
104
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
107
raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
108
"application locale.").format(a, user_encoding))
108
111
def make_readonly(filename):
109
112
"""Make a filename read-only."""
110
113
mod = os.lstat(filename).st_mode
111
114
if not stat.S_ISLNK(mod):
113
os.chmod(filename, mod)
116
chmod_if_possible(filename, mod)
116
119
def make_writable(filename):
117
120
mod = os.lstat(filename).st_mode
118
121
if not stat.S_ISLNK(mod):
120
os.chmod(filename, mod)
123
chmod_if_possible(filename, mod)
126
def chmod_if_possible(filename, mode):
127
# Set file mode if that can be safely done.
128
# Sometimes even on unix the filesystem won't allow it - see
129
# https://bugs.launchpad.net/bzr/+bug/606537
131
# It is probably faster to just do the chmod, rather than
132
# doing a stat, and then trying to compare
133
os.chmod(filename, mode)
134
except (IOError, OSError) as e:
135
# Permission/access denied seems to commonly happen on smbfs; there's
136
# probably no point warning about it.
137
# <https://bugs.launchpad.net/bzr/+bug/606537>
138
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
139
trace.mutter("ignore error on chmod of %r: %r" % (
123
145
def minimum_path_selection(paths):
232
254
file_existed = False
234
256
rename_func(new, tmp_name)
235
except (errors.NoSuchFile,), e:
257
except (errors.NoSuchFile,) as e:
238
260
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
261
# function raises an IOError with errno is None when a rename fails.
240
262
# This then gets caught here.
241
263
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
265
except Exception as e:
244
266
if (getattr(e, 'errno', None) is None
245
267
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
248
270
file_existed = True
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
274
# This may throw an exception, in which case success will
276
rename_func(old, new)
278
except (IOError, OSError) as e:
279
# source and target may be aliases of each other (e.g. on a
280
# case-insensitive filesystem), so we may have accidentally renamed
281
# source by when we tried to rename target
282
if (file_existed and e.errno in (None, errno.ENOENT)
283
and old.lower() == new.lower()):
284
# source and target are the same file on a case-insensitive
285
# filesystem, so we don't generate an exception
270
291
# If the file used to exist, rename it back into place
273
294
unlink_func(tmp_name)
275
296
rename_func(tmp_name, new)
276
if failure_exc is not None:
277
raise failure_exc[0], failure_exc[1], failure_exc[2]
280
299
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
300
# choke on a Unicode string containing a relative path if
282
301
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
303
def _posix_abspath(path):
286
304
# jam 20060426 rather than encoding to fsencoding
287
305
# copy posixpath.abspath, but use os.getcwdu instead
288
306
if not posixpath.isabs(path):
289
307
path = posixpath.join(getcwd(), path)
290
return posixpath.normpath(path)
308
return _posix_normpath(path)
293
311
def _posix_realpath(path):
294
312
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
315
def _posix_normpath(path):
316
path = posixpath.normpath(path)
317
# Bug 861008: posixpath.normpath() returns a path normalized according to
318
# the POSIX standard, which stipulates (for compatibility reasons) that two
319
# leading slashes must not be simplified to one, and only if there are 3 or
320
# more should they be simplified as one. So we treat the leading 2 slashes
321
# as a special case here by simply removing the first slash, as we consider
322
# that breaking POSIX compatibility for this obscure feature is acceptable.
323
# This is not a paranoid precaution, as we notably get paths like this when
324
# the repo is hosted at the root of the filesystem, i.e. in "/".
325
if path.startswith('//'):
330
def _posix_path_from_environ(key):
331
"""Get unicode path from `key` in environment or None if not present
333
Note that posix systems use arbitrary byte strings for filesystem objects,
334
so a path that raises BadFilenameEncoding here may still be accessible.
336
val = os.environ.get(key, None)
340
return val.decode(_fs_enc)
341
except UnicodeDecodeError:
342
# GZ 2011-12-12:Ideally want to include `key` in the exception message
343
raise errors.BadFilenameEncoding(val, _fs_enc)
346
def _posix_get_home_dir():
347
"""Get the home directory of the current user as a unicode path"""
348
path = posixpath.expanduser("~")
350
return path.decode(_fs_enc)
351
except AttributeError:
353
except UnicodeDecodeError:
354
raise errors.BadFilenameEncoding(path, _fs_enc)
357
def _posix_getuser_unicode():
358
"""Get username from environment or password database as unicode"""
359
name = getpass.getuser()
360
user_encoding = get_user_encoding()
362
return name.decode(user_encoding)
363
except UnicodeDecodeError:
364
raise errors.BzrError("Encoding of username %r is unsupported by %s "
365
"application locale." % (name, user_encoding))
297
368
def _win32_fixdrive(path):
298
369
"""Force drive letters to be consistent.
326
397
# /path => C:/path
327
398
path = unicode(path)
328
399
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
400
drive = ntpath.splitdrive(path)[0]
330
401
if drive == '' and path[:2] not in('//','\\\\'):
332
403
# we cannot simply os.path.join cwd and path
333
404
# because os.path.join('C:','/path') produce '/path'
334
405
# and this is incorrect
335
406
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
407
cwd = ntpath.splitdrive(cwd)[0]
338
409
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
410
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
413
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('\\', '/'))
414
# Real ntpath.realpath doesn't have a problem with a unicode cwd
415
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
418
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
419
return ntpath.join(*args).replace('\\', '/')
351
422
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
423
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
426
def _win32_getcwd():
356
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
427
return _win32_fixdrive(_getcwd().replace('\\', '/'))
359
430
def _win32_mkdtemp(*args, **kwargs):
360
431
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
434
def _win32_rename(old, new):
372
435
"""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)
399
452
def _mac_getcwd():
400
return unicodedata.normalize('NFC', os.getcwdu())
453
return unicodedata.normalize('NFC', _getcwd())
456
def _rename_wrap_exception(rename_func):
457
"""Adds extra information to any exceptions that come from rename().
459
The exception has an updated message and 'old_filename' and 'new_filename'
463
def _rename_wrapper(old, new):
465
rename_func(old, new)
467
detailed_error = OSError(e.errno, e.strerror +
468
" [occurred when renaming '%s' to '%s']" %
470
detailed_error.old_filename = old
471
detailed_error.new_filename = new
474
return _rename_wrapper
477
if sys.version_info > (3,):
483
# Default rename wraps os.rename()
484
rename = _rename_wrap_exception(os.rename)
403
486
# Default is to just use the python builtins, but these can be rebound on
404
487
# particular platforms.
405
488
abspath = _posix_abspath
406
489
realpath = _posix_realpath
407
490
pathjoin = os.path.join
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
491
normpath = _posix_normpath
492
path_from_environ = _posix_path_from_environ
493
_get_home_dir = _posix_get_home_dir
494
getuser_unicode = _posix_getuser_unicode
411
496
dirname = os.path.dirname
412
497
basename = os.path.basename
413
498
split = os.path.split
414
499
splitext = os.path.splitext
415
# These were already imported into local scope
500
# These were already lazily imported into local scope
416
501
# mkdtemp = tempfile.mkdtemp
417
502
# rmtree = shutil.rmtree
419
510
MIN_ABS_PATHLENGTH = 1
471
573
On my standard US Windows XP, the preferred encoding is
472
574
cp1252, but the console is cp437
576
:param trace: If True trace the selected encoding via mutter().
474
from bzrlib.trace import mutter
578
from .trace import mutter
475
579
output_encoding = getattr(sys.stdout, 'encoding', None)
476
580
if not output_encoding:
477
581
input_encoding = getattr(sys.stdin, 'encoding', None)
478
582
if not input_encoding:
479
583
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
585
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
588
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
590
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
594
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
595
if output_encoding == 'cp0':
488
596
# invalid encoding (cp0 means 'no codepage' on Windows)
489
597
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
599
mutter('cp0 is invalid encoding.'
491
600
' encoding stdout as osutils.get_user_encoding() %r',
495
604
codecs.lookup(output_encoding)
496
605
except LookupError:
497
sys.stderr.write('bzr: warning:'
606
sys.stderr.write('brz: warning:'
498
607
' unknown terminal encoding %s.\n'
499
608
' Using encoding %s instead.\n'
500
609
% (output_encoding, get_user_encoding())
798
918
(date_fmt, tt, offset_str) = \
799
919
_format_date(t, offset, timezone, date_fmt, show_offset)
800
920
date_str = time.strftime(date_fmt, tt)
801
if not isinstance(date_str, unicode):
921
if not isinstance(date_str, text_type):
802
922
date_str = date_str.decode(get_user_encoding(), 'replace')
803
923
return date_str + offset_str
806
926
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
927
if timezone == 'utc':
810
930
elif timezone == 'original':
811
931
if offset is None:
813
tt = time.gmtime(t + offset)
933
tt = gmtime(t + offset)
814
934
elif timezone == 'local':
815
935
tt = time.localtime(t)
816
936
offset = local_time_offset(t)
881
1001
def filesize(f):
882
1002
"""Return size of given open file."""
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
1003
return os.fstat(f.fileno())[stat.ST_SIZE]
1006
# Alias os.urandom to support platforms (which?) without /dev/urandom and
1007
# override if it doesn't work. Avoid checking on windows where there is
1008
# significant initialisation cost that can be avoided for some bzr calls.
1010
rand_bytes = os.urandom
1012
if rand_bytes.__module__ != "nt":
896
rand_bytes = file('/dev/urandom', 'rb').read
897
# Otherwise, use this hack as a last resort
898
except (IOError, OSError):
1015
except NotImplementedError:
899
1016
# not well seeded, but better than nothing
900
1017
def rand_bytes(n):
970
1087
implementation should be loaded instead::
973
>>> import bzrlib._fictional_extension_pyx
1090
>>> import breezy._fictional_extension_pyx
974
1091
>>> except ImportError, e:
975
>>> bzrlib.osutils.failed_to_load_extension(e)
976
>>> import bzrlib._fictional_extension_py
1092
>>> breezy.osutils.failed_to_load_extension(e)
1093
>>> import breezy._fictional_extension_py
978
1095
# NB: This docstring is just an example, not a doctest, because doctest
979
1096
# currently can't cope with the use of lazy imports in this namespace --
982
1099
# This currently doesn't report the failure at the time it occurs, because
983
1100
# they tend to happen very early in startup when we can't check config
984
1101
# files etc, and also we want to report all failures but not spam the user
985
1102
# with 10 warnings.
986
from bzrlib import trace
987
1103
exception_str = str(exception)
988
1104
if exception_str not in _extension_load_failures:
989
1105
trace.mutter("failed to load compiled extension: %s" % exception_str)
1049
1164
os.link(src, dest)
1050
except (OSError, IOError), e:
1165
except (OSError, IOError) as e:
1051
1166
if e.errno != errno.EXDEV:
1053
1168
shutil.copyfile(src, dest)
1056
1171
def delete_any(path):
1057
"""Delete a file, symlink or directory.
1172
"""Delete a file, symlink or directory.
1059
1174
Will delete even if readonly.
1062
1177
_delete_file_or_dir(path)
1063
except (OSError, IOError), e:
1178
except (OSError, IOError) as e:
1064
1179
if e.errno in (errno.EPERM, errno.EACCES):
1065
1180
# make writable and try again
1250
1365
# but for now, we haven't optimized...
1251
1366
return [canonical_relpath(base, p) for p in paths]
1369
def decode_filename(filename):
1370
"""Decode the filename using the filesystem encoding
1372
If it is unicode, it is returned.
1373
Otherwise it is decoded from the the filesystem's encoding. If decoding
1374
fails, a errors.BadFilenameEncoding exception is raised.
1376
if isinstance(filename, text_type):
1379
return filename.decode(_fs_enc)
1380
except UnicodeDecodeError:
1381
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1384
def safe_unicode(unicode_or_utf8_string):
1254
1385
"""Coerce unicode_or_utf8_string into unicode.
1424
1561
None is returned if the width can't established precisely.
1427
- if BZR_COLUMNS is set, returns its value
1564
- if BRZ_COLUMNS is set, returns its value
1428
1565
- if there is no controlling terminal, returns None
1566
- query the OS, if the queried size has changed since the last query,
1429
1568
- if COLUMNS is set, returns its value,
1569
- if the OS has a value (even though it's never changed), return its value.
1431
1571
From there, we need to query the OS to get the size of the controlling
1574
On Unices we query the OS by:
1435
1575
- get termios.TIOCGWINSZ
1436
1576
- if an error occurs or a negative value is obtained, returns None
1578
On Windows we query the OS by:
1440
1579
- win32utils.get_console_size() decides,
1441
1580
- returns None on error (provided default value)
1582
# Note to implementors: if changing the rules for determining the width,
1583
# make sure you've considered the behaviour in these cases:
1584
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1585
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1587
# - (add more interesting cases here, if you find any)
1588
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1589
# but we don't want to register a signal handler because it is impossible
1590
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1591
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1592
# time so we can notice if the reported size has changed, which should have
1444
# If BZR_COLUMNS is set, take it, user is always right
1595
# If BRZ_COLUMNS is set, take it, user is always right
1596
# Except if they specified 0 in which case, impose no limit here
1446
return int(os.environ['BZR_COLUMNS'])
1598
width = int(os.environ['BRZ_COLUMNS'])
1447
1599
except (KeyError, ValueError):
1601
if width is not None:
1450
1607
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1608
if isatty is None or not isatty():
1609
# Don't guess, setting BRZ_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))
1613
width, height = os_size = _terminal_size(None, None)
1614
global _first_terminal_size, _terminal_size_state
1615
if _terminal_size_state == 'no_data':
1616
_first_terminal_size = os_size
1617
_terminal_size_state = 'unchanged'
1618
elif (_terminal_size_state == 'unchanged' and
1619
_first_terminal_size != os_size):
1620
_terminal_size_state = 'changed'
1622
# If the OS claims to know how wide the terminal is, and this value has
1623
# ever changed, use that.
1624
if _terminal_size_state == 'changed':
1625
if width is not None and width > 0:
1628
# If COLUMNS is set, use it.
1459
1630
return int(os.environ['COLUMNS'])
1460
1631
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1634
# Finally, use an unchanged size from the OS, if we have one.
1635
if _terminal_size_state == 'unchanged':
1636
if width is not None and width > 0:
1639
# The width could not be determined.
1471
1643
def _win32_terminal_size(width, height):
1498
1670
_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
1673
def supports_executable():
1527
1674
return sys.platform != "win32"
1886
2034
_cached_user_encoding = None
1889
def get_user_encoding(use_cache=True):
2037
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
2038
"""Find out what the preferred user encoding is.
1892
2040
This is generally the encoding that is used for command line parameters
1893
2041
and file contents. This may be different from the terminal encoding
1894
2042
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)
1900
2044
:return: A string defining the preferred user encoding
1902
2046
global _cached_user_encoding
1903
if _cached_user_encoding is not None and use_cache:
2047
if deprecated_passed(use_cache):
2048
warn_deprecated("use_cache should only have been used for tests",
2049
DeprecationWarning, stacklevel=2)
2050
if _cached_user_encoding is not None:
1904
2051
return _cached_user_encoding
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'
2053
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2054
# Use the existing locale settings and call nl_langinfo directly
2055
# rather than going through getpreferredencoding. This avoids
2056
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2057
# possibility of the setlocale call throwing an error.
2058
user_encoding = locale.nl_langinfo(locale.CODESET)
2060
# GZ 2011-12-19: On windows could call GetACP directly instead.
2061
user_encoding = locale.getpreferredencoding(False)
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:'
2064
user_encoding = codecs.lookup(user_encoding).name
2066
if user_encoding not in ("", "cp0"):
2067
sys.stderr.write('brz: warning:'
1950
2068
' unknown encoding %s.'
1951
2069
' Continuing with ascii encoding.\n'
1952
2070
% user_encoding
1954
user_encoding = 'ascii'
1957
_cached_user_encoding = user_encoding
2072
user_encoding = 'ascii'
2074
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2075
if user_encoding == 'ascii':
2076
if sys.platform == 'darwin':
2077
# OSX is special-cased in Python to have a UTF-8 filesystem
2078
# encoding and previously had LANG set here if not present.
2079
user_encoding = 'utf-8'
2080
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2081
# for some other posix platforms as well.
2083
_cached_user_encoding = user_encoding
1959
2084
return user_encoding
2087
def get_diff_header_encoding():
2088
return get_terminal_encoding()
1962
2091
def get_host_name():
1963
2092
"""Return the current unicode host name.
2043
2179
while sent_total < byte_count:
2045
2181
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
except socket.error, e:
2182
except (socket.error, IOError) as e:
2183
if e.args[0] in _end_of_stream_errors:
2184
raise errors.ConnectionReset(
2185
"Error trying to write to socket", e)
2047
2186
if e.args[0] != errno.EINTR:
2190
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2050
2192
sent_total += sent
2051
report_activity(sent, 'write')
2193
if report_activity is not None:
2194
report_activity(sent, 'write')
2197
def connect_socket(address):
2198
# Slight variation of the socket.create_connection() function (provided by
2199
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2200
# provide it for previous python versions. Also, we don't use the timeout
2201
# parameter (provided by the python implementation) so we don't implement
2203
err = socket.error('getaddrinfo returns an empty list')
2204
host, port = address
2205
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2206
af, socktype, proto, canonname, sa = res
2209
sock = socket.socket(af, socktype, proto)
2213
except socket.error as err:
2214
# 'err' is now the most recent error
2215
if sock is not None:
2054
2220
def dereference_path(path):
2082
2248
If and when pkg_resources becomes a standard library, this routine
2083
2249
can delegate to it.
2085
# Check package name is within bzrlib
2086
if package == "bzrlib":
2251
# Check package name is within breezy
2252
if package == "breezy":
2087
2253
resource_relpath = resource_name
2088
elif package.startswith("bzrlib."):
2089
package = package[len("bzrlib."):].replace('.', os.sep)
2254
elif package.startswith("breezy."):
2255
package = package[len("breezy."):].replace('.', os.sep)
2090
2256
resource_relpath = pathjoin(package, resource_name)
2092
raise errors.BzrError('resource package %s not in bzrlib' % package)
2258
raise errors.BzrError('resource package %s not in breezy' % package)
2094
2260
# Map the resource to a file and read its contents
2095
base = dirname(bzrlib.__file__)
2261
base = dirname(breezy.__file__)
2096
2262
if getattr(sys, 'frozen', None): # bzr.exe
2097
2263
base = abspath(pathjoin(base, '..', '..'))
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2264
f = file(pathjoin(base, resource_relpath), "rU")
2102
2270
def file_kind_from_stat_mode_thunk(mode):
2103
2271
global file_kind_from_stat_mode
2104
2272
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2106
from bzrlib._readdir_pyx import UTF8DirReader
2274
from ._readdir_pyx import UTF8DirReader
2107
2275
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
except ImportError, e:
2276
except ImportError as e:
2109
2277
# This is one time where we won't warn that an extension failed to
2110
2278
# load. The extension is never available on Windows anyway.
2111
from bzrlib._readdir_py import (
2279
from ._readdir_py import (
2112
2280
_kind_from_mode as file_kind_from_stat_mode
2114
2282
return file_kind_from_stat_mode(mode)
2115
2283
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2118
def file_kind(f, _lstat=os.lstat):
2285
def file_stat(f, _lstat=os.lstat):
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2289
except OSError as e:
2122
2290
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2291
raise errors.NoSuchFile(f)
2294
def file_kind(f, _lstat=os.lstat):
2295
stat_value = file_stat(f, _lstat)
2296
return file_kind_from_stat_mode(stat_value.st_mode)
2127
2298
def until_no_eintr(f, *a, **kw):
2128
2299
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2301
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2302
if EINTR does occur. This is typically only true for low-level operations
2132
2303
like os.read. If in any doubt, don't use this.
2134
2305
Keep in mind that this is not a complete solution to EINTR. There is
2135
2306
probably code in the Python standard library and other dependencies that
2136
2307
may encounter EINTR if a signal arrives (and there is signal handler for
2137
that signal). So this function can reduce the impact for IO that bzrlib
2308
that signal). So this function can reduce the impact for IO that breezy
2138
2309
directly controls, but it is not a complete solution.
2140
2311
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2143
2314
return f(*a, **kw)
2144
except (IOError, OSError), e:
2315
except (IOError, OSError) as e:
2145
2316
if e.errno == errno.EINTR:
2321
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2322
def re_compile_checked(re_string, flags=0, where=""):
2151
2323
"""Return a compiled re, or raise a sensible error.
2187
2359
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2191
if sys.platform == 'linux2':
2362
if sys.platform.startswith('linux'):
2192
2363
def _local_concurrency():
2194
prefix = 'processor'
2195
for line in file('/proc/cpuinfo', 'rb'):
2196
if line.startswith(prefix):
2197
concurrency = int(line[line.find(':')+1:]) + 1
2365
return os.sysconf('SC_NPROCESSORS_ONLN')
2366
except (ValueError, OSError, AttributeError):
2199
2368
elif sys.platform == 'darwin':
2200
2369
def _local_concurrency():
2201
2370
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2371
stdout=subprocess.PIPE).communicate()[0]
2203
elif sys.platform[0:7] == 'freebsd':
2372
elif "bsd" in sys.platform:
2204
2373
def _local_concurrency():
2205
2374
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2375
stdout=subprocess.PIPE).communicate()[0]
2231
2400
if _cached_local_concurrency is not None and use_cache:
2232
2401
return _cached_local_concurrency
2234
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2403
concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2404
if concurrency is None:
2237
concurrency = _local_concurrency()
2238
except (OSError, IOError):
2406
import multiprocessing
2407
concurrency = multiprocessing.cpu_count()
2408
except (ImportError, NotImplementedError):
2409
# multiprocessing is only available on Python >= 2.6
2410
# and multiprocessing.cpu_count() isn't implemented on all
2413
concurrency = _local_concurrency()
2414
except (OSError, IOError):
2241
2417
concurrency = int(concurrency)
2242
2418
except (TypeError, ValueError):
2302
2478
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2480
open_file = open
2483
def available_backup_name(base, exists):
2484
"""Find a non-existing backup file name.
2486
This will *not* create anything, this only return a 'free' entry. This
2487
should be used for checking names in a directory below a locked
2488
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2489
Leap) and generally discouraged.
2491
:param base: The base name.
2493
:param exists: A callable returning True if the path parameter exists.
2496
name = "%s.~%d~" % (base, counter)
2499
name = "%s.~%d~" % (base, counter)
2503
def set_fd_cloexec(fd):
2504
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2505
support for this is not available.
2509
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2510
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2511
except (ImportError, AttributeError):
2512
# Either the fcntl module or specific constants are not present
2516
def find_executable_on_path(name):
2517
"""Finds an executable on the PATH.
2519
On Windows, this will try to append each extension in the PATHEXT
2520
environment variable to the name, if it cannot be found with the name
2523
:param name: The base name of the executable.
2524
:return: The path to the executable found or None.
2526
if sys.platform == 'win32':
2527
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2528
exts = [ext.lower() for ext in exts]
2529
base, ext = os.path.splitext(name)
2531
if ext.lower() not in exts:
2537
path = os.environ.get('PATH')
2538
if path is not None:
2539
path = path.split(os.pathsep)
2542
f = os.path.join(d, name) + ext
2543
if os.access(f, os.X_OK):
2545
if sys.platform == 'win32':
2546
app_path = win32utils.get_app_path(name)
2547
if app_path != name:
2552
def _posix_is_local_pid_dead(pid):
2553
"""True if pid doesn't correspond to live process on this machine"""
2555
# Special meaning of unix kill: just check if it's there.
2557
except OSError as e:
2558
if e.errno == errno.ESRCH:
2559
# On this machine, and really not found: as sure as we can be
2562
elif e.errno == errno.EPERM:
2563
# exists, though not ours
2566
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2567
# Don't really know.
2570
# Exists and our process: not dead.
2573
if sys.platform == "win32":
2574
is_local_pid_dead = win32utils.is_local_pid_dead
2576
is_local_pid_dead = _posix_is_local_pid_dead
2578
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2579
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2580
if getattr(errno, name, None) is not None]
2583
def fdatasync(fileno):
2584
"""Flush file contents to disk if possible.
2586
:param fileno: Integer OS file handle.
2587
:raises TransportNotPossible: If flushing to disk is not possible.
2589
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2593
except IOError as e:
2594
# See bug #1075108, on some platforms fdatasync exists, but can
2595
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2596
# and reduce the chance of corruption-on-powerloss situations. It
2597
# is not a mandatory call, so it is ok to suppress failures.
2598
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2599
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2603
def ensure_empty_directory_exists(path, exception_class):
2604
"""Make sure a local directory exists and is empty.
2606
If it does not exist, it is created. If it exists and is not empty, an
2607
instance of exception_class is raised.
2611
except OSError as e:
2612
if e.errno != errno.EEXIST:
2614
if os.listdir(path) != []:
2615
raise exception_class(path)
2618
def is_environment_error(evalue):
2619
"""True if exception instance is due to a process environment issue
2621
This includes OSError and IOError, but also other errors that come from
2622
the operating system or core libraries but are not subclasses of those.
2624
if isinstance(evalue, (EnvironmentError, select.error)):
2626
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):