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):
287
299
# copy posixpath.abspath, but use os.getcwdu instead
288
300
if not posixpath.isabs(path):
289
301
path = posixpath.join(getcwd(), path)
290
return posixpath.normpath(path)
302
return _posix_normpath(path)
293
305
def _posix_realpath(path):
294
306
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
309
def _posix_normpath(path):
310
path = posixpath.normpath(path)
311
# Bug 861008: posixpath.normpath() returns a path normalized according to
312
# the POSIX standard, which stipulates (for compatibility reasons) that two
313
# leading slashes must not be simplified to one, and only if there are 3 or
314
# more should they be simplified as one. So we treat the leading 2 slashes
315
# as a special case here by simply removing the first slash, as we consider
316
# that breaking POSIX compatibility for this obscure feature is acceptable.
317
# This is not a paranoid precaution, as we notably get paths like this when
318
# the repo is hosted at the root of the filesystem, i.e. in "/".
319
if path.startswith('//'):
324
def _posix_path_from_environ(key):
325
"""Get unicode path from `key` in environment or None if not present
327
Note that posix systems use arbitrary byte strings for filesystem objects,
328
so a path that raises BadFilenameEncoding here may still be accessible.
330
val = os.environ.get(key, None)
334
return val.decode(_fs_enc)
335
except UnicodeDecodeError:
336
# GZ 2011-12-12:Ideally want to include `key` in the exception message
337
raise errors.BadFilenameEncoding(val, _fs_enc)
340
def _posix_getuser_unicode():
341
"""Get username from environment or password database as unicode"""
342
name = getpass.getuser()
343
user_encoding = get_user_encoding()
345
return name.decode(user_encoding)
346
except UnicodeDecodeError:
347
raise errors.BzrError("Encoding of username %r is unsupported by %s "
348
"application locale." % (name, user_encoding))
297
351
def _win32_fixdrive(path):
298
352
"""Force drive letters to be consistent.
303
357
running python.exe under cmd.exe return capital C:\\
304
358
running win32 python inside a cygwin shell returns lowercase c:\\
306
drive, path = _nt_splitdrive(path)
360
drive, path = ntpath.splitdrive(path)
307
361
return drive.upper() + path
310
364
def _win32_abspath(path):
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
365
# Real ntpath.abspath doesn't have a problem with a unicode cwd
366
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
315
369
def _win98_abspath(path):
326
380
# /path => C:/path
327
381
path = unicode(path)
328
382
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
383
drive = ntpath.splitdrive(path)[0]
330
384
if drive == '' and path[:2] not in('//','\\\\'):
331
385
cwd = os.getcwdu()
332
386
# we cannot simply os.path.join cwd and path
333
387
# because os.path.join('C:','/path') produce '/path'
334
388
# and this is incorrect
335
389
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
390
cwd = ntpath.splitdrive(cwd)[0]
338
392
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
393
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
396
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('\\', '/'))
397
# Real ntpath.realpath doesn't have a problem with a unicode cwd
398
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
401
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
402
return ntpath.join(*args).replace('\\', '/')
351
405
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
406
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
409
def _win32_getcwd():
405
441
abspath = _posix_abspath
406
442
realpath = _posix_realpath
407
443
pathjoin = os.path.join
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
444
normpath = _posix_normpath
445
path_from_environ = _posix_path_from_environ
446
getuser_unicode = _posix_getuser_unicode
410
447
getcwd = os.getcwdu
411
449
dirname = os.path.dirname
412
450
basename = os.path.basename
413
451
split = os.path.split
414
452
splitext = os.path.splitext
415
# These were already imported into local scope
453
# These were already lazily imported into local scope
416
454
# mkdtemp = tempfile.mkdtemp
417
455
# rmtree = shutil.rmtree
419
463
MIN_ABS_PATHLENGTH = 1
477
533
input_encoding = getattr(sys.stdin, 'encoding', None)
478
534
if not input_encoding:
479
535
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
537
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
540
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
542
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
546
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
547
if output_encoding == 'cp0':
488
548
# invalid encoding (cp0 means 'no codepage' on Windows)
489
549
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
551
mutter('cp0 is invalid encoding.'
491
552
' encoding stdout as osutils.get_user_encoding() %r',
1250
1309
# but for now, we haven't optimized...
1251
1310
return [canonical_relpath(base, p) for p in paths]
1313
def decode_filename(filename):
1314
"""Decode the filename using the filesystem encoding
1316
If it is unicode, it is returned.
1317
Otherwise it is decoded from the the filesystem's encoding. If decoding
1318
fails, a errors.BadFilenameEncoding exception is raised.
1320
if type(filename) is unicode:
1323
return filename.decode(_fs_enc)
1324
except UnicodeDecodeError:
1325
raise errors.BadFilenameEncoding(filename, _fs_enc)
1253
1328
def safe_unicode(unicode_or_utf8_string):
1254
1329
"""Coerce unicode_or_utf8_string into unicode.
1427
1508
- if BZR_COLUMNS is set, returns its value
1428
1509
- if there is no controlling terminal, returns None
1510
- query the OS, if the queried size has changed since the last query,
1429
1512
- if COLUMNS is set, returns its value,
1513
- if the OS has a value (even though it's never changed), return its value.
1431
1515
From there, we need to query the OS to get the size of the controlling
1518
On Unices we query the OS by:
1435
1519
- get termios.TIOCGWINSZ
1436
1520
- if an error occurs or a negative value is obtained, returns None
1522
On Windows we query the OS by:
1440
1523
- win32utils.get_console_size() decides,
1441
1524
- returns None on error (provided default value)
1526
# Note to implementors: if changing the rules for determining the width,
1527
# make sure you've considered the behaviour in these cases:
1528
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1529
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1531
# - (add more interesting cases here, if you find any)
1532
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1533
# but we don't want to register a signal handler because it is impossible
1534
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1535
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1536
# time so we can notice if the reported size has changed, which should have
1444
1539
# If BZR_COLUMNS is set, take it, user is always right
1540
# Except if they specified 0 in which case, impose no limit here
1446
return int(os.environ['BZR_COLUMNS'])
1542
width = int(os.environ['BZR_COLUMNS'])
1447
1543
except (KeyError, ValueError):
1545
if width is not None:
1450
1551
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1552
if isatty is None or not isatty():
1452
1553
# 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))
1557
width, height = os_size = _terminal_size(None, None)
1558
global _first_terminal_size, _terminal_size_state
1559
if _terminal_size_state == 'no_data':
1560
_first_terminal_size = os_size
1561
_terminal_size_state = 'unchanged'
1562
elif (_terminal_size_state == 'unchanged' and
1563
_first_terminal_size != os_size):
1564
_terminal_size_state = 'changed'
1566
# If the OS claims to know how wide the terminal is, and this value has
1567
# ever changed, use that.
1568
if _terminal_size_state == 'changed':
1569
if width is not None and width > 0:
1572
# If COLUMNS is set, use it.
1459
1574
return int(os.environ['COLUMNS'])
1460
1575
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1578
# Finally, use an unchanged size from the OS, if we have one.
1579
if _terminal_size_state == 'unchanged':
1580
if width is not None and width > 0:
1583
# The width could not be determined.
1471
1587
def _win32_terminal_size(width, height):
1498
1614
_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
1617
def supports_executable():
1527
1618
return sys.platform != "win32"
1959
2053
return user_encoding
2056
def get_diff_header_encoding():
2057
return get_terminal_encoding()
2060
_message_encoding = None
2063
def get_message_encoding():
2064
"""Return the encoding used for messages
2066
While the message encoding is a general setting it should usually only be
2067
needed for decoding system error strings such as from OSError instances.
2069
global _message_encoding
2070
if _message_encoding is None:
2071
if os.name == "posix":
2073
# This is a process-global setting that can change, but should in
2074
# general just get set once at process startup then be constant.
2075
_message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
2077
# On windows want the result of GetACP() which this boils down to.
2078
_message_encoding = get_user_encoding()
2079
return _message_encoding or "ascii"
1962
2082
def get_host_name():
1963
2083
"""Return the current unicode host name.
2051
2179
report_activity(sent, 'write')
2182
def connect_socket(address):
2183
# Slight variation of the socket.create_connection() function (provided by
2184
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2185
# provide it for previous python versions. Also, we don't use the timeout
2186
# parameter (provided by the python implementation) so we don't implement
2188
err = socket.error('getaddrinfo returns an empty list')
2189
host, port = address
2190
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2191
af, socktype, proto, canonname, sa = res
2194
sock = socket.socket(af, socktype, proto)
2198
except socket.error, err:
2199
# 'err' is now the most recent error
2200
if sock is not None:
2054
2205
def dereference_path(path):
2055
2206
"""Determine the real path to a file.
2114
2267
return file_kind_from_stat_mode(mode)
2115
2268
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2118
def file_kind(f, _lstat=os.lstat):
2270
def file_stat(f, _lstat=os.lstat):
2120
return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
2274
except OSError, e:
2122
2275
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2276
raise errors.NoSuchFile(f)
2279
def file_kind(f, _lstat=os.lstat):
2280
stat_value = file_stat(f, _lstat)
2281
return file_kind_from_stat_mode(stat_value.st_mode)
2127
2283
def until_no_eintr(f, *a, **kw):
2128
2284
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2286
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2287
if EINTR does occur. This is typically only true for low-level operations
2132
2288
like os.read. If in any doubt, don't use this.
2187
2344
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2191
if sys.platform == 'linux2':
2347
if sys.platform.startswith('linux'):
2192
2348
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
2350
return os.sysconf('SC_NPROCESSORS_ONLN')
2351
except (ValueError, OSError, AttributeError):
2199
2353
elif sys.platform == 'darwin':
2200
2354
def _local_concurrency():
2201
2355
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2356
stdout=subprocess.PIPE).communicate()[0]
2203
elif sys.platform[0:7] == 'freebsd':
2357
elif "bsd" in sys.platform:
2204
2358
def _local_concurrency():
2205
2359
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2360
stdout=subprocess.PIPE).communicate()[0]
2234
2388
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2389
if concurrency is None:
2237
concurrency = _local_concurrency()
2238
except (OSError, IOError):
2391
import multiprocessing
2392
concurrency = multiprocessing.cpu_count()
2393
except (ImportError, NotImplementedError):
2394
# multiprocessing is only available on Python >= 2.6
2395
# and multiprocessing.cpu_count() isn't implemented on all
2398
concurrency = _local_concurrency()
2399
except (OSError, IOError):
2241
2402
concurrency = int(concurrency)
2242
2403
except (TypeError, ValueError):
2302
2463
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2465
open_file = open
2468
def available_backup_name(base, exists):
2469
"""Find a non-existing backup file name.
2471
This will *not* create anything, this only return a 'free' entry. This
2472
should be used for checking names in a directory below a locked
2473
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2474
Leap) and generally discouraged.
2476
:param base: The base name.
2478
:param exists: A callable returning True if the path parameter exists.
2481
name = "%s.~%d~" % (base, counter)
2484
name = "%s.~%d~" % (base, counter)
2488
def set_fd_cloexec(fd):
2489
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2490
support for this is not available.
2494
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2495
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2496
except (ImportError, AttributeError):
2497
# Either the fcntl module or specific constants are not present
2501
def find_executable_on_path(name):
2502
"""Finds an executable on the PATH.
2504
On Windows, this will try to append each extension in the PATHEXT
2505
environment variable to the name, if it cannot be found with the name
2508
:param name: The base name of the executable.
2509
:return: The path to the executable found or None.
2511
path = os.environ.get('PATH')
2514
path = path.split(os.pathsep)
2515
if sys.platform == 'win32':
2516
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2517
exts = [ext.lower() for ext in exts]
2518
base, ext = os.path.splitext(name)
2520
if ext.lower() not in exts:
2528
f = os.path.join(d, name) + ext
2529
if os.access(f, os.X_OK):
2534
def _posix_is_local_pid_dead(pid):
2535
"""True if pid doesn't correspond to live process on this machine"""
2537
# Special meaning of unix kill: just check if it's there.
2540
if e.errno == errno.ESRCH:
2541
# On this machine, and really not found: as sure as we can be
2544
elif e.errno == errno.EPERM:
2545
# exists, though not ours
2548
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2549
# Don't really know.
2552
# Exists and our process: not dead.
2555
if sys.platform == "win32":
2556
is_local_pid_dead = win32utils.is_local_pid_dead
2558
is_local_pid_dead = _posix_is_local_pid_dead
2561
def fdatasync(fileno):
2562
"""Flush file contents to disk if possible.
2564
:param fileno: Integer OS file handle.
2565
:raises TransportNotPossible: If flushing to disk is not possible.
2567
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2572
def ensure_empty_directory_exists(path, exception_class):
2573
"""Make sure a local directory exists and is empty.
2575
If it does not exist, it is created. If it exists and is not empty, an
2576
instance of exception_class is raised.
2581
if e.errno != errno.EEXIST:
2583
if os.listdir(path) != []:
2584
raise exception_class(path)
2587
def is_environment_error(evalue):
2588
"""True if exception instance is due to a process environment issue
2590
This includes OSError and IOError, but also other errors that come from
2591
the operating system or core libraries but are not subclasses of those.
2593
if isinstance(evalue, (EnvironmentError, select.error)):
2595
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):