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,
32
# We need to import both shutil and rmtree as we export the later on posix
33
# and need the former on windows
35
from shutil import rmtree
38
# We need to import both tempfile and mkdtemp as we export the later on posix
39
# and need the former on windows
43
from tempfile import (
41
from tempfile import mkdtemp
48
44
from bzrlib import (
51
from bzrlib.i18n import gettext
56
54
from bzrlib.symbol_versioning import (
110
100
mod = os.lstat(filename).st_mode
111
101
if not stat.S_ISLNK(mod):
112
102
mod = mod & 0777555
113
os.chmod(filename, mod)
103
chmod_if_possible(filename, mod)
116
106
def make_writable(filename):
117
107
mod = os.lstat(filename).st_mode
118
108
if not stat.S_ISLNK(mod):
120
os.chmod(filename, mod)
110
chmod_if_possible(filename, mod)
113
def chmod_if_possible(filename, mode):
114
# Set file mode if that can be safely done.
115
# Sometimes even on unix the filesystem won't allow it - see
116
# https://bugs.launchpad.net/bzr/+bug/606537
118
# It is probably faster to just do the chmod, rather than
119
# doing a stat, and then trying to compare
120
os.chmod(filename, mode)
121
except (IOError, OSError),e:
122
# Permission/access denied seems to commonly happen on smbfs; there's
123
# probably no point warning about it.
124
# <https://bugs.launchpad.net/bzr/+bug/606537>
125
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
126
trace.mutter("ignore error on chmod of %r: %r" % (
123
132
def minimum_path_selection(paths):
275
284
rename_func(tmp_name, new)
276
285
if failure_exc is not None:
277
raise failure_exc[0], failure_exc[1], failure_exc[2]
287
raise failure_exc[0], failure_exc[1], failure_exc[2]
280
292
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
293
# choke on a Unicode string containing a relative path if
282
294
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
296
def _posix_abspath(path):
286
297
# jam 20060426 rather than encoding to fsencoding
287
298
# copy posixpath.abspath, but use os.getcwdu instead
288
299
if not posixpath.isabs(path):
289
300
path = posixpath.join(getcwd(), path)
290
return posixpath.normpath(path)
301
return _posix_normpath(path)
293
304
def _posix_realpath(path):
294
305
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
308
def _posix_normpath(path):
309
path = posixpath.normpath(path)
310
# Bug 861008: posixpath.normpath() returns a path normalized according to
311
# the POSIX standard, which stipulates (for compatibility reasons) that two
312
# leading slashes must not be simplified to one, and only if there are 3 or
313
# more should they be simplified as one. So we treat the leading 2 slashes
314
# as a special case here by simply removing the first slash, as we consider
315
# that breaking POSIX compatibility for this obscure feature is acceptable.
316
# This is not a paranoid precaution, as we notably get paths like this when
317
# the repo is hosted at the root of the filesystem, i.e. in "/".
318
if path.startswith('//'):
297
323
def _win32_fixdrive(path):
298
324
"""Force drive letters to be consistent.
326
352
# /path => C:/path
327
353
path = unicode(path)
328
354
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
355
drive = ntpath.splitdrive(path)[0]
330
356
if drive == '' and path[:2] not in('//','\\\\'):
331
357
cwd = os.getcwdu()
332
358
# we cannot simply os.path.join cwd and path
333
359
# because os.path.join('C:','/path') produce '/path'
334
360
# and this is incorrect
335
361
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
362
cwd = ntpath.splitdrive(cwd)[0]
338
364
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
365
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
368
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('\\', '/'))
369
# Real ntpath.realpath doesn't have a problem with a unicode cwd
370
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
373
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
374
return ntpath.join(*args).replace('\\', '/')
351
377
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
378
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
381
def _win32_getcwd():
477
501
input_encoding = getattr(sys.stdin, 'encoding', None)
478
502
if not input_encoding:
479
503
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
505
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
508
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
510
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
514
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
515
if output_encoding == 'cp0':
488
516
# invalid encoding (cp0 means 'no codepage' on Windows)
489
517
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
519
mutter('cp0 is invalid encoding.'
491
520
' encoding stdout as osutils.get_user_encoding() %r',
1250
1277
# but for now, we haven't optimized...
1251
1278
return [canonical_relpath(base, p) for p in paths]
1281
def decode_filename(filename):
1282
"""Decode the filename using the filesystem encoding
1284
If it is unicode, it is returned.
1285
Otherwise it is decoded from the the filesystem's encoding. If decoding
1286
fails, a errors.BadFilenameEncoding exception is raised.
1288
if type(filename) is unicode:
1291
return filename.decode(_fs_enc)
1292
except UnicodeDecodeError:
1293
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1296
def safe_unicode(unicode_or_utf8_string):
1254
1297
"""Coerce unicode_or_utf8_string into unicode.
1427
1476
- if BZR_COLUMNS is set, returns its value
1428
1477
- if there is no controlling terminal, returns None
1478
- query the OS, if the queried size has changed since the last query,
1429
1480
- if COLUMNS is set, returns its value,
1481
- if the OS has a value (even though it's never changed), return its value.
1431
1483
From there, we need to query the OS to get the size of the controlling
1486
On Unices we query the OS by:
1435
1487
- get termios.TIOCGWINSZ
1436
1488
- if an error occurs or a negative value is obtained, returns None
1490
On Windows we query the OS by:
1440
1491
- win32utils.get_console_size() decides,
1441
1492
- returns None on error (provided default value)
1494
# Note to implementors: if changing the rules for determining the width,
1495
# make sure you've considered the behaviour in these cases:
1496
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1497
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1499
# - (add more interesting cases here, if you find any)
1500
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1501
# but we don't want to register a signal handler because it is impossible
1502
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1503
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1504
# time so we can notice if the reported size has changed, which should have
1444
1507
# If BZR_COLUMNS is set, take it, user is always right
1508
# Except if they specified 0 in which case, impose no limit here
1446
return int(os.environ['BZR_COLUMNS'])
1510
width = int(os.environ['BZR_COLUMNS'])
1447
1511
except (KeyError, ValueError):
1513
if width is not None:
1450
1519
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1520
if isatty is None or not isatty():
1452
1521
# 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))
1525
width, height = os_size = _terminal_size(None, None)
1526
global _first_terminal_size, _terminal_size_state
1527
if _terminal_size_state == 'no_data':
1528
_first_terminal_size = os_size
1529
_terminal_size_state = 'unchanged'
1530
elif (_terminal_size_state == 'unchanged' and
1531
_first_terminal_size != os_size):
1532
_terminal_size_state = 'changed'
1534
# If the OS claims to know how wide the terminal is, and this value has
1535
# ever changed, use that.
1536
if _terminal_size_state == 'changed':
1537
if width is not None and width > 0:
1540
# If COLUMNS is set, use it.
1459
1542
return int(os.environ['COLUMNS'])
1460
1543
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1546
# Finally, use an unchanged size from the OS, if we have one.
1547
if _terminal_size_state == 'unchanged':
1548
if width is not None and width > 0:
1551
# The width could not be determined.
1471
1555
def _win32_terminal_size(width, height):
1498
1582
_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
1585
def supports_executable():
1527
1586
return sys.platform != "win32"
1959
2019
return user_encoding
2022
def get_diff_header_encoding():
2023
return get_terminal_encoding()
2026
_message_encoding = None
2029
def get_message_encoding():
2030
"""Return the encoding used for messages
2032
While the message encoding is a general setting it should usually only be
2033
needed for decoding system error strings such as from OSError instances.
2035
global _message_encoding
2036
if _message_encoding is None:
2037
if os.name == "posix":
2039
# This is a process-global setting that can change, but should in
2040
# general just get set once at process startup then be constant.
2041
_message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
2043
# On windows want the result of GetACP() which this boils down to.
2044
_message_encoding = get_user_encoding()
2045
return _message_encoding or "ascii"
1962
2048
def get_host_name():
1963
2049
"""Return the current unicode host name.
2051
2145
report_activity(sent, 'write')
2148
def connect_socket(address):
2149
# Slight variation of the socket.create_connection() function (provided by
2150
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2151
# provide it for previous python versions. Also, we don't use the timeout
2152
# parameter (provided by the python implementation) so we don't implement
2154
err = socket.error('getaddrinfo returns an empty list')
2155
host, port = address
2156
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2157
af, socktype, proto, canonname, sa = res
2160
sock = socket.socket(af, socktype, proto)
2164
except socket.error, err:
2165
# 'err' is now the most recent error
2166
if sock is not None:
2054
2171
def dereference_path(path):
2055
2172
"""Determine the real path to a file.
2114
2233
return file_kind_from_stat_mode(mode)
2115
2234
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2118
def file_kind(f, _lstat=os.lstat):
2236
def file_stat(f, _lstat=os.lstat):
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
2240
except OSError, e:
2122
2241
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2242
raise errors.NoSuchFile(f)
2245
def file_kind(f, _lstat=os.lstat):
2246
stat_value = file_stat(f, _lstat)
2247
return file_kind_from_stat_mode(stat_value.st_mode)
2127
2249
def until_no_eintr(f, *a, **kw):
2128
2250
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2252
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2253
if EINTR does occur. This is typically only true for low-level operations
2132
2254
like os.read. If in any doubt, don't use this.
2187
2310
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2191
if sys.platform == 'linux2':
2313
if sys.platform.startswith('linux'):
2192
2314
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
2316
return os.sysconf('SC_NPROCESSORS_ONLN')
2317
except (ValueError, OSError, AttributeError):
2199
2319
elif sys.platform == 'darwin':
2200
2320
def _local_concurrency():
2201
2321
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2322
stdout=subprocess.PIPE).communicate()[0]
2203
elif sys.platform[0:7] == 'freebsd':
2323
elif "bsd" in sys.platform:
2204
2324
def _local_concurrency():
2205
2325
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2326
stdout=subprocess.PIPE).communicate()[0]
2302
2429
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2431
open_file = open
2434
def getuser_unicode():
2435
"""Return the username as unicode.
2438
user_encoding = get_user_encoding()
2439
username = getpass.getuser().decode(user_encoding)
2440
except UnicodeDecodeError:
2441
raise errors.BzrError("Can't decode username as %s." % \
2443
except ImportError, e:
2444
if sys.platform != 'win32':
2446
if str(e) != 'No module named pwd':
2448
# https://bugs.launchpad.net/bzr/+bug/660174
2449
# getpass.getuser() is unable to return username on Windows
2450
# if there is no USERNAME environment variable set.
2451
# That could be true if bzr is running as a service,
2452
# e.g. running `bzr serve` as a service on Windows.
2453
# We should not fail with traceback in this case.
2454
username = u'UNKNOWN'
2458
def available_backup_name(base, exists):
2459
"""Find a non-existing backup file name.
2461
This will *not* create anything, this only return a 'free' entry. This
2462
should be used for checking names in a directory below a locked
2463
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2464
Leap) and generally discouraged.
2466
:param base: The base name.
2468
:param exists: A callable returning True if the path parameter exists.
2471
name = "%s.~%d~" % (base, counter)
2474
name = "%s.~%d~" % (base, counter)
2478
def set_fd_cloexec(fd):
2479
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2480
support for this is not available.
2484
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2485
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2486
except (ImportError, AttributeError):
2487
# Either the fcntl module or specific constants are not present
2491
def find_executable_on_path(name):
2492
"""Finds an executable on the PATH.
2494
On Windows, this will try to append each extension in the PATHEXT
2495
environment variable to the name, if it cannot be found with the name
2498
:param name: The base name of the executable.
2499
:return: The path to the executable found or None.
2501
path = os.environ.get('PATH')
2504
path = path.split(os.pathsep)
2505
if sys.platform == 'win32':
2506
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2507
exts = [ext.lower() for ext in exts]
2508
base, ext = os.path.splitext(name)
2510
if ext.lower() not in exts:
2518
f = os.path.join(d, name) + ext
2519
if os.access(f, os.X_OK):
2524
def _posix_is_local_pid_dead(pid):
2525
"""True if pid doesn't correspond to live process on this machine"""
2527
# Special meaning of unix kill: just check if it's there.
2530
if e.errno == errno.ESRCH:
2531
# On this machine, and really not found: as sure as we can be
2534
elif e.errno == errno.EPERM:
2535
# exists, though not ours
2538
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2539
# Don't really know.
2542
# Exists and our process: not dead.
2545
if sys.platform == "win32":
2546
is_local_pid_dead = win32utils.is_local_pid_dead
2548
is_local_pid_dead = _posix_is_local_pid_dead
2551
def fdatasync(fileno):
2552
"""Flush file contents to disk if possible.
2554
:param fileno: Integer OS file handle.
2555
:raises TransportNotPossible: If flushing to disk is not possible.
2557
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2562
def ensure_empty_directory_exists(path, exception_class):
2563
"""Make sure a local directory exists and is empty.
2565
If it does not exist, it is created. If it exists and is not empty, an
2566
instance of exception_class is raised.
2571
if e.errno != errno.EEXIST:
2573
if os.listdir(path) != []:
2574
raise exception_class(path)
2577
def is_environment_error(evalue):
2578
"""True if exception instance is due to a process environment issue
2580
This includes OSError and IOError, but also other errors that come from
2581
the operating system or core libraries but are not subclasses of those.
2583
if isinstance(evalue, (EnvironmentError, select.error)):
2585
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):