/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import errno
20
17
import os
21
18
import re
22
19
import stat
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
23
21
import sys
24
22
import time
25
23
import codecs
27
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
33
35
import posixpath
34
 
import select
35
 
# We need to import both shutil and rmtree as we export the later on posix
36
 
# and need the former on windows
37
36
import shutil
38
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
39
40
import socket
40
41
import subprocess
41
 
# We need to import both tempfile and mkdtemp as we export the later on posix
42
 
# and need the former on windows
43
42
import tempfile
44
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
45
46
import unicodedata
46
47
 
47
48
from bzrlib import (
48
49
    cache_utf8,
49
 
    config,
50
50
    errors,
51
51
    trace,
52
52
    win32utils,
53
53
    )
54
 
from bzrlib.i18n import gettext
55
54
""")
56
55
 
57
56
from bzrlib.symbol_versioning import (
58
 
    DEPRECATED_PARAMETER,
59
57
    deprecated_function,
60
58
    deprecated_in,
61
 
    deprecated_passed,
62
 
    warn as warn_deprecated,
63
59
    )
64
60
 
65
 
from hashlib import (
66
 
    md5,
67
 
    sha1 as sha,
68
 
    )
 
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
62
# of 2.5
 
63
if sys.version_info < (2, 5):
 
64
    import md5 as _mod_md5
 
65
    md5 = _mod_md5.new
 
66
    import sha as _mod_sha
 
67
    sha = _mod_sha.new
 
68
else:
 
69
    from hashlib import (
 
70
        md5,
 
71
        sha1 as sha,
 
72
        )
69
73
 
70
74
 
71
75
import bzrlib
72
 
from bzrlib import symbol_versioning, _fs_enc
 
76
from bzrlib import symbol_versioning
73
77
 
74
78
 
75
79
# Cross platform wall-clock time functionality with decent resolution.
97
101
        user_encoding = get_user_encoding()
98
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
103
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
            "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
102
106
 
103
107
 
104
108
def make_readonly(filename):
106
110
    mod = os.lstat(filename).st_mode
107
111
    if not stat.S_ISLNK(mod):
108
112
        mod = mod & 0777555
109
 
        chmod_if_possible(filename, mod)
 
113
        os.chmod(filename, mod)
110
114
 
111
115
 
112
116
def make_writable(filename):
113
117
    mod = os.lstat(filename).st_mode
114
118
    if not stat.S_ISLNK(mod):
115
119
        mod = mod | 0200
116
 
        chmod_if_possible(filename, mod)
117
 
 
118
 
 
119
 
def chmod_if_possible(filename, mode):
120
 
    # Set file mode if that can be safely done.
121
 
    # Sometimes even on unix the filesystem won't allow it - see
122
 
    # https://bugs.launchpad.net/bzr/+bug/606537
123
 
    try:
124
 
        # It is probably faster to just do the chmod, rather than
125
 
        # doing a stat, and then trying to compare
126
 
        os.chmod(filename, mode)
127
 
    except (IOError, OSError),e:
128
 
        # Permission/access denied seems to commonly happen on smbfs; there's
129
 
        # probably no point warning about it.
130
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
131
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
132
 
            trace.mutter("ignore error on chmod of %r: %r" % (
133
 
                filename, e))
134
 
            return
135
 
        raise
 
120
        os.chmod(filename, mod)
136
121
 
137
122
 
138
123
def minimum_path_selection(paths):
217
202
            if e.errno == errno.ENOENT:
218
203
                return False;
219
204
            else:
220
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
221
206
 
222
207
 
223
208
def fancy_rename(old, new, rename_func, unlink_func):
289
274
            else:
290
275
                rename_func(tmp_name, new)
291
276
    if failure_exc is not None:
292
 
        try:
293
 
            raise failure_exc[0], failure_exc[1], failure_exc[2]
294
 
        finally:
295
 
            del failure_exc
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
296
278
 
297
279
 
298
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
281
# choke on a Unicode string containing a relative path if
300
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
285
def _posix_abspath(path):
303
286
    # jam 20060426 rather than encoding to fsencoding
304
287
    # copy posixpath.abspath, but use os.getcwdu instead
305
288
    if not posixpath.isabs(path):
306
289
        path = posixpath.join(getcwd(), path)
307
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
308
291
 
309
292
 
310
293
def _posix_realpath(path):
311
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
295
 
313
296
 
314
 
def _posix_normpath(path):
315
 
    path = posixpath.normpath(path)
316
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
317
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
318
 
    # leading slashes must not be simplified to one, and only if there are 3 or
319
 
    # more should they be simplified as one. So we treat the leading 2 slashes
320
 
    # as a special case here by simply removing the first slash, as we consider
321
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
322
 
    # This is not a paranoid precaution, as we notably get paths like this when
323
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
324
 
    if path.startswith('//'):
325
 
        path = path[1:]
326
 
    return path
327
 
 
328
 
 
329
 
def _posix_path_from_environ(key):
330
 
    """Get unicode path from `key` in environment or None if not present
331
 
 
332
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
333
 
    so a path that raises BadFilenameEncoding here may still be accessible.
334
 
    """
335
 
    val = os.environ.get(key, None)
336
 
    if val is None:
337
 
        return val
338
 
    try:
339
 
        return val.decode(_fs_enc)
340
 
    except UnicodeDecodeError:
341
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
342
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
343
 
 
344
 
 
345
 
def _posix_getuser_unicode():
346
 
    """Get username from environment or password database as unicode"""
347
 
    name = getpass.getuser()
348
 
    user_encoding = get_user_encoding()
349
 
    try:
350
 
        return name.decode(user_encoding)
351
 
    except UnicodeDecodeError:
352
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
353
 
            "application locale." % (name, user_encoding))
354
 
 
355
 
 
356
297
def _win32_fixdrive(path):
357
298
    """Force drive letters to be consistent.
358
299
 
362
303
    running python.exe under cmd.exe return capital C:\\
363
304
    running win32 python inside a cygwin shell returns lowercase c:\\
364
305
    """
365
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
366
307
    return drive.upper() + path
367
308
 
368
309
 
369
310
def _win32_abspath(path):
370
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
371
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
372
313
 
373
314
 
374
315
def _win98_abspath(path):
385
326
    #   /path       => C:/path
386
327
    path = unicode(path)
387
328
    # check for absolute path
388
 
    drive = ntpath.splitdrive(path)[0]
 
329
    drive = _nt_splitdrive(path)[0]
389
330
    if drive == '' and path[:2] not in('//','\\\\'):
390
331
        cwd = os.getcwdu()
391
332
        # we cannot simply os.path.join cwd and path
392
333
        # because os.path.join('C:','/path') produce '/path'
393
334
        # and this is incorrect
394
335
        if path[:1] in ('/','\\'):
395
 
            cwd = ntpath.splitdrive(cwd)[0]
 
336
            cwd = _nt_splitdrive(cwd)[0]
396
337
            path = path[1:]
397
338
        path = cwd + '\\' + path
398
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
399
340
 
400
341
 
401
342
def _win32_realpath(path):
402
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
403
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
404
345
 
405
346
 
406
347
def _win32_pathjoin(*args):
407
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
408
349
 
409
350
 
410
351
def _win32_normpath(path):
411
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
412
353
 
413
354
 
414
355
def _win32_getcwd():
419
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
420
361
 
421
362
 
 
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))
 
366
    new_e.filename = old
 
367
    new_e.to_filename = new
 
368
    return new_e
 
369
 
 
370
 
422
371
def _win32_rename(old, new):
423
372
    """We expect to be able to atomically replace 'new' with old.
424
373
 
426
375
    and then deleted.
427
376
    """
428
377
    try:
429
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
430
379
    except OSError, e:
431
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
432
381
            # If we try to rename a non-existant file onto cwd, we get
437
386
        raise
438
387
 
439
388
 
 
389
def _wrapped_rename(old, new):
 
390
    """Rename a file or directory"""
 
391
    try:
 
392
        os.rename(old, new)
 
393
    except (IOError, OSError), e:
 
394
        # this is eventually called by all rename-like functions, so should 
 
395
        # catch all of them
 
396
        raise _add_rename_error_details(e, old, new)
 
397
 
 
398
 
440
399
def _mac_getcwd():
441
400
    return unicodedata.normalize('NFC', os.getcwdu())
442
401
 
446
405
abspath = _posix_abspath
447
406
realpath = _posix_realpath
448
407
pathjoin = os.path.join
449
 
normpath = _posix_normpath
450
 
path_from_environ = _posix_path_from_environ
451
 
getuser_unicode = _posix_getuser_unicode
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
452
410
getcwd = os.getcwdu
453
 
rename = os.rename
454
411
dirname = os.path.dirname
455
412
basename = os.path.basename
456
413
split = os.path.split
457
414
splitext = os.path.splitext
458
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
459
416
# mkdtemp = tempfile.mkdtemp
460
417
# rmtree = shutil.rmtree
461
 
lstat = os.lstat
462
 
fstat = os.fstat
463
 
 
464
 
def wrap_stat(st):
465
 
    return st
466
 
 
467
418
 
468
419
MIN_ABS_PATHLENGTH = 1
469
420
 
479
430
    getcwd = _win32_getcwd
480
431
    mkdtemp = _win32_mkdtemp
481
432
    rename = _win32_rename
482
 
    try:
483
 
        from bzrlib import _walkdirs_win32
484
 
    except ImportError:
485
 
        pass
486
 
    else:
487
 
        lstat = _walkdirs_win32.lstat
488
 
        fstat = _walkdirs_win32.fstat
489
 
        wrap_stat = _walkdirs_win32.wrap_stat
490
433
 
491
434
    MIN_ABS_PATHLENGTH = 3
492
435
 
510
453
    f = win32utils.get_unicode_argv     # special function or None
511
454
    if f is not None:
512
455
        get_unicode_argv = f
513
 
    path_from_environ = win32utils.get_environ_unicode
514
 
    getuser_unicode = win32utils.get_user_name
515
456
 
516
457
elif sys.platform == 'darwin':
517
458
    getcwd = _mac_getcwd
518
459
 
519
460
 
520
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
521
462
    """Find the best encoding for printing to the screen.
522
463
 
523
464
    This attempts to check both sys.stdout and sys.stdin to see
529
470
 
530
471
    On my standard US Windows XP, the preferred encoding is
531
472
    cp1252, but the console is cp437
532
 
 
533
 
    :param trace: If True trace the selected encoding via mutter().
534
473
    """
535
474
    from bzrlib.trace import mutter
536
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
538
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
539
478
        if not input_encoding:
540
479
            output_encoding = get_user_encoding()
541
 
            if trace:
542
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
543
481
                   output_encoding)
544
482
        else:
545
483
            output_encoding = input_encoding
546
 
            if trace:
547
 
                mutter('encoding stdout as sys.stdin encoding %r',
548
 
                    output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
549
485
    else:
550
 
        if trace:
551
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
552
487
    if output_encoding == 'cp0':
553
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
554
489
        output_encoding = get_user_encoding()
555
 
        if trace:
556
 
            mutter('cp0 is invalid encoding.'
 
490
        mutter('cp0 is invalid encoding.'
557
491
               ' encoding stdout as osutils.get_user_encoding() %r',
558
492
               output_encoding)
559
493
    # check encoding
585
519
def isdir(f):
586
520
    """True if f is an accessible directory."""
587
521
    try:
588
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
589
523
    except OSError:
590
524
        return False
591
525
 
593
527
def isfile(f):
594
528
    """True if f is a regular file."""
595
529
    try:
596
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
597
531
    except OSError:
598
532
        return False
599
533
 
600
534
def islink(f):
601
535
    """True if f is a symlink."""
602
536
    try:
603
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
604
538
    except OSError:
605
539
        return False
606
540
 
946
880
 
947
881
def filesize(f):
948
882
    """Return size of given open file."""
949
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
950
 
 
951
 
 
952
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
953
 
# override if it doesn't work. Avoid checking on windows where there is
954
 
# significant initialisation cost that can be avoided for some bzr calls.
955
 
 
956
 
rand_bytes = os.urandom
957
 
 
958
 
if rand_bytes.__module__ != "nt":
 
883
    return os.fstat(f.fileno())[ST_SIZE]
 
884
 
 
885
 
 
886
# Define rand_bytes based on platform.
 
887
try:
 
888
    # Python 2.4 and later have os.urandom,
 
889
    # but it doesn't work on some arches
 
890
    os.urandom(1)
 
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
959
895
    try:
960
 
        rand_bytes(1)
961
 
    except NotImplementedError:
 
896
        rand_bytes = file('/dev/urandom', 'rb').read
 
897
    # Otherwise, use this hack as a last resort
 
898
    except (IOError, OSError):
962
899
        # not well seeded, but better than nothing
963
900
        def rand_bytes(n):
964
901
            import random
994
931
    rps = []
995
932
    for f in ps:
996
933
        if f == '..':
997
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
998
935
        elif (f == '.') or (f == ''):
999
936
            pass
1000
937
        else:
1005
942
def joinpath(p):
1006
943
    for f in p:
1007
944
        if (f == '..') or (f is None) or (f == ''):
1008
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1009
946
    return pathjoin(*p)
1010
947
 
1011
948
 
1012
949
def parent_directories(filename):
1013
950
    """Return the list of parent directories, deepest first.
1014
 
 
 
951
    
1015
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1016
953
    """
1017
954
    parents = []
1041
978
    # NB: This docstring is just an example, not a doctest, because doctest
1042
979
    # currently can't cope with the use of lazy imports in this namespace --
1043
980
    # mbp 20090729
1044
 
 
 
981
    
1045
982
    # This currently doesn't report the failure at the time it occurs, because
1046
983
    # they tend to happen very early in startup when we can't check config
1047
984
    # files etc, and also we want to report all failures but not spam the user
1048
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1049
987
    exception_str = str(exception)
1050
988
    if exception_str not in _extension_load_failures:
1051
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1055
993
def report_extension_load_failures():
1056
994
    if not _extension_load_failures:
1057
995
        return
1058
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1059
998
        return
1060
999
    # the warnings framework should by default show this only once
1061
1000
    from bzrlib.trace import warning
1115
1054
 
1116
1055
 
1117
1056
def delete_any(path):
1118
 
    """Delete a file, symlink or directory.
1119
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1120
1059
    Will delete even if readonly.
1121
1060
    """
1122
1061
    try:
1223
1162
 
1224
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1225
1164
        # must have space for e.g. a drive letter
1226
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1165
        raise ValueError('%r is too short to calculate a relative path'
1227
1166
            % (base,))
1228
1167
 
1229
1168
    rp = abspath(path)
1311
1250
    # but for now, we haven't optimized...
1312
1251
    return [canonical_relpath(base, p) for p in paths]
1313
1252
 
1314
 
 
1315
 
def decode_filename(filename):
1316
 
    """Decode the filename using the filesystem encoding
1317
 
 
1318
 
    If it is unicode, it is returned.
1319
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1320
 
    fails, a errors.BadFilenameEncoding exception is raised.
1321
 
    """
1322
 
    if type(filename) is unicode:
1323
 
        return filename
1324
 
    try:
1325
 
        return filename.decode(_fs_enc)
1326
 
    except UnicodeDecodeError:
1327
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1328
 
 
1329
 
 
1330
1253
def safe_unicode(unicode_or_utf8_string):
1331
1254
    """Coerce unicode_or_utf8_string into unicode.
1332
1255
 
1415
1338
def normalizes_filenames():
1416
1339
    """Return True if this platform normalizes unicode filenames.
1417
1340
 
1418
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1419
1342
    """
1420
1343
    return _platform_normalizes_filenames
1421
1344
 
1426
1349
    On platforms where the system normalizes filenames (Mac OSX),
1427
1350
    you can access a file by any path which will normalize correctly.
1428
1351
    On platforms where the system does not normalize filenames
1429
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1430
1353
 
1431
1354
    Internally, bzr only supports NFC normalization, since that is
1432
1355
    the standard for XML documents.
1494
1417
terminal_width() returns None.
1495
1418
"""
1496
1419
 
1497
 
# Keep some state so that terminal_width can detect if _terminal_size has
1498
 
# returned a different size since the process started.  See docstring and
1499
 
# comments of terminal_width for details.
1500
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1501
 
_terminal_size_state = 'no_data'
1502
 
_first_terminal_size = None
1503
1420
 
1504
1421
def terminal_width():
1505
1422
    """Return terminal width.
1509
1426
    The rules are:
1510
1427
    - if BZR_COLUMNS is set, returns its value
1511
1428
    - if there is no controlling terminal, returns None
1512
 
    - query the OS, if the queried size has changed since the last query,
1513
 
      return its value,
1514
1429
    - if COLUMNS is set, returns its value,
1515
 
    - if the OS has a value (even though it's never changed), return its value.
1516
1430
 
1517
1431
    From there, we need to query the OS to get the size of the controlling
1518
1432
    terminal.
1519
1433
 
1520
 
    On Unices we query the OS by:
 
1434
    Unices:
1521
1435
    - get termios.TIOCGWINSZ
1522
1436
    - if an error occurs or a negative value is obtained, returns None
1523
1437
 
1524
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1525
1440
    - win32utils.get_console_size() decides,
1526
1441
    - returns None on error (provided default value)
1527
1442
    """
1528
 
    # Note to implementors: if changing the rules for determining the width,
1529
 
    # make sure you've considered the behaviour in these cases:
1530
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1531
 
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1532
 
    #    0,0.
1533
 
    #  - (add more interesting cases here, if you find any)
1534
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1535
 
    # but we don't want to register a signal handler because it is impossible
1536
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1537
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1538
 
    # time so we can notice if the reported size has changed, which should have
1539
 
    # a similar effect.
1540
1443
 
1541
1444
    # If BZR_COLUMNS is set, take it, user is always right
1542
 
    # Except if they specified 0 in which case, impose no limit here
1543
1445
    try:
1544
 
        width = int(os.environ['BZR_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1545
1447
    except (KeyError, ValueError):
1546
 
        width = None
1547
 
    if width is not None:
1548
 
        if width > 0:
1549
 
            return width
1550
 
        else:
1551
 
            return None
 
1448
        pass
1552
1449
 
1553
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1554
 
    if isatty is None or not isatty():
 
1451
    if  isatty is None or not isatty():
1555
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1556
1453
        return None
1557
1454
 
1558
 
    # Query the OS
1559
 
    width, height = os_size = _terminal_size(None, None)
1560
 
    global _first_terminal_size, _terminal_size_state
1561
 
    if _terminal_size_state == 'no_data':
1562
 
        _first_terminal_size = os_size
1563
 
        _terminal_size_state = 'unchanged'
1564
 
    elif (_terminal_size_state == 'unchanged' and
1565
 
          _first_terminal_size != os_size):
1566
 
        _terminal_size_state = 'changed'
1567
 
 
1568
 
    # If the OS claims to know how wide the terminal is, and this value has
1569
 
    # ever changed, use that.
1570
 
    if _terminal_size_state == 'changed':
1571
 
        if width is not None and width > 0:
1572
 
            return width
1573
 
 
1574
 
    # 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))
1575
1458
    try:
1576
1459
        return int(os.environ['COLUMNS'])
1577
1460
    except (KeyError, ValueError):
1578
1461
        pass
1579
1462
 
1580
 
    # Finally, use an unchanged size from the OS, if we have one.
1581
 
    if _terminal_size_state == 'unchanged':
1582
 
        if width is not None and width > 0:
1583
 
            return width
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1584
1467
 
1585
 
    # The width could not be determined.
1586
 
    return None
 
1468
    return width
1587
1469
 
1588
1470
 
1589
1471
def _win32_terminal_size(width, height):
1616
1498
    _terminal_size = _ioctl_terminal_size
1617
1499
 
1618
1500
 
 
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)
 
1506
 
 
1507
 
 
1508
_registered_sigwinch = False
 
1509
def watch_sigwinch():
 
1510
    """Register for SIGWINCH, once and only once.
 
1511
 
 
1512
    Do nothing if the signal module is not available.
 
1513
    """
 
1514
    global _registered_sigwinch
 
1515
    if not _registered_sigwinch:
 
1516
        try:
 
1517
            import signal
 
1518
            if getattr(signal, "SIGWINCH", None) is not None:
 
1519
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1520
        except ImportError:
 
1521
            # python doesn't provide signal support, nothing we can do about it
 
1522
            pass
 
1523
        _registered_sigwinch = True
 
1524
 
 
1525
 
1619
1526
def supports_executable():
1620
1527
    return sys.platform != "win32"
1621
1528
 
1744
1651
        dirblock = []
1745
1652
        append = dirblock.append
1746
1653
        try:
1747
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1654
            names = sorted(_listdir(top))
1748
1655
        except OSError, e:
1749
1656
            if not _is_error_enotdir(e):
1750
1657
                raise
1804
1711
    """
1805
1712
    global _selected_dir_reader
1806
1713
    if _selected_dir_reader is None:
 
1714
        fs_encoding = _fs_enc.upper()
1807
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1808
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
1809
1717
            # TODO: We possibly could support Win98 by falling back to the
1815
1723
                _selected_dir_reader = Win32ReadDir()
1816
1724
            except ImportError:
1817
1725
                pass
1818
 
        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
1819
1728
            try:
1820
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1821
1730
                _selected_dir_reader = UTF8DirReader()
1956
1865
        s = os.stat(src)
1957
1866
        chown(dst, s.st_uid, s.st_gid)
1958
1867
    except OSError, e:
1959
 
        trace.warning(
1960
 
            'Unable to copy ownership from "%s" to "%s". '
1961
 
            'You may want to set it manually.', src, dst)
1962
 
        trace.log_exception_quietly()
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1963
1869
 
1964
1870
 
1965
1871
def path_prefix_key(path):
1980
1886
_cached_user_encoding = None
1981
1887
 
1982
1888
 
1983
 
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
 
1889
def get_user_encoding(use_cache=True):
1984
1890
    """Find out what the preferred user encoding is.
1985
1891
 
1986
1892
    This is generally the encoding that is used for command line parameters
1987
1893
    and file contents. This may be different from the terminal encoding
1988
1894
    or the filesystem encoding.
1989
1895
 
 
1896
    :param  use_cache:  Enable cache for detected encoding.
 
1897
                        (This parameter is turned on by default,
 
1898
                        and required only for selftesting)
 
1899
 
1990
1900
    :return: A string defining the preferred user encoding
1991
1901
    """
1992
1902
    global _cached_user_encoding
1993
 
    if deprecated_passed(use_cache):
1994
 
        warn_deprecated("use_cache should only have been used for tests",
1995
 
            DeprecationWarning, stacklevel=2) 
1996
 
    if _cached_user_encoding is not None:
 
1903
    if _cached_user_encoding is not None and use_cache:
1997
1904
        return _cached_user_encoding
1998
1905
 
1999
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2000
 
        # Use the existing locale settings and call nl_langinfo directly
2001
 
        # rather than going through getpreferredencoding. This avoids
2002
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2003
 
        # possibility of the setlocale call throwing an error.
2004
 
        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'
 
1910
        try:
 
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'
 
1920
            import locale
 
1921
        finally:
 
1922
            sys.platform = 'darwin'
2005
1923
    else:
2006
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2007
 
        user_encoding = locale.getpreferredencoding(False)
 
1924
        import locale
2008
1925
 
2009
1926
    try:
2010
 
        user_encoding = codecs.lookup(user_encoding).name
2011
 
    except LookupError:
2012
 
        if user_encoding not in ("", "cp0"):
 
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'
 
1936
 
 
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
 
1939
    # console.
 
1940
    #
 
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'
 
1944
    else:
 
1945
        # check encoding
 
1946
        try:
 
1947
            codecs.lookup(user_encoding)
 
1948
        except LookupError:
2013
1949
            sys.stderr.write('bzr: warning:'
2014
1950
                             ' unknown encoding %s.'
2015
1951
                             ' Continuing with ascii encoding.\n'
2016
1952
                             % user_encoding
2017
1953
                            )
2018
 
        user_encoding = 'ascii'
2019
 
    else:
2020
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2021
 
        if user_encoding == 'ascii':
2022
 
            if sys.platform == 'darwin':
2023
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2024
 
                # encoding and previously had LANG set here if not present.
2025
 
                user_encoding = 'utf-8'
2026
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2027
 
            #                for some other posix platforms as well.
2028
 
 
2029
 
    _cached_user_encoding = user_encoding
 
1954
            user_encoding = 'ascii'
 
1955
 
 
1956
    if use_cache:
 
1957
        _cached_user_encoding = user_encoding
 
1958
 
2030
1959
    return user_encoding
2031
1960
 
2032
1961
 
2033
 
def get_diff_header_encoding():
2034
 
    return get_terminal_encoding()
2035
 
 
2036
 
 
2037
1962
def get_host_name():
2038
1963
    """Return the current unicode host name.
2039
1964
 
2041
1966
    behaves inconsistently on different platforms.
2042
1967
    """
2043
1968
    if sys.platform == "win32":
 
1969
        import win32utils
2044
1970
        return win32utils.get_host_name()
2045
1971
    else:
2046
1972
        import socket
2053
1979
# data at once.
2054
1980
MAX_SOCKET_CHUNK = 64 * 1024
2055
1981
 
2056
 
_end_of_stream_errors = [errno.ECONNRESET]
2057
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2058
 
    _eno = getattr(errno, _eno, None)
2059
 
    if _eno is not None:
2060
 
        _end_of_stream_errors.append(_eno)
2061
 
del _eno
2062
 
 
2063
 
 
2064
1982
def read_bytes_from_socket(sock, report_activity=None,
2065
1983
        max_read_size=MAX_SOCKET_CHUNK):
2066
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2074
1992
            bytes = sock.recv(max_read_size)
2075
1993
        except socket.error, e:
2076
1994
            eno = e.args[0]
2077
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2078
1996
                # The connection was closed by the other side.  Callers expect
2079
1997
                # an empty string to signal end-of-stream.
2080
1998
                return ""
2109
2027
 
2110
2028
def send_all(sock, bytes, report_activity=None):
2111
2029
    """Send all bytes on a socket.
2112
 
 
 
2030
 
2113
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2114
2032
    some platforms, and catches EINTR which may be thrown if the send is
2115
2033
    interrupted by a signal.
2116
2034
 
2117
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2118
2036
    and provides activity reporting.
2119
 
 
 
2037
 
2120
2038
    :param report_activity: Call this as bytes are read, see
2121
2039
        Transport._report_activity
2122
2040
    """
2133
2051
            report_activity(sent, 'write')
2134
2052
 
2135
2053
 
2136
 
def connect_socket(address):
2137
 
    # Slight variation of the socket.create_connection() function (provided by
2138
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2139
 
    # provide it for previous python versions. Also, we don't use the timeout
2140
 
    # parameter (provided by the python implementation) so we don't implement
2141
 
    # it either).
2142
 
    err = socket.error('getaddrinfo returns an empty list')
2143
 
    host, port = address
2144
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2145
 
        af, socktype, proto, canonname, sa = res
2146
 
        sock = None
2147
 
        try:
2148
 
            sock = socket.socket(af, socktype, proto)
2149
 
            sock.connect(sa)
2150
 
            return sock
2151
 
 
2152
 
        except socket.error, err:
2153
 
            # 'err' is now the most recent error
2154
 
            if sock is not None:
2155
 
                sock.close()
2156
 
    raise err
2157
 
 
2158
 
 
2159
2054
def dereference_path(path):
2160
2055
    """Determine the real path to a file.
2161
2056
 
2200
2095
    base = dirname(bzrlib.__file__)
2201
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2202
2097
        base = abspath(pathjoin(base, '..', '..'))
2203
 
    f = file(pathjoin(base, resource_relpath), "rU")
2204
 
    try:
2205
 
        return f.read()
2206
 
    finally:
2207
 
        f.close()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
 
2100
 
2208
2101
 
2209
2102
def file_kind_from_stat_mode_thunk(mode):
2210
2103
    global file_kind_from_stat_mode
2221
2114
    return file_kind_from_stat_mode(mode)
2222
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2223
2116
 
2224
 
def file_stat(f, _lstat=os.lstat):
 
2117
 
 
2118
def file_kind(f, _lstat=os.lstat):
2225
2119
    try:
2226
 
        # XXX cache?
2227
 
        return _lstat(f)
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2228
2121
    except OSError, e:
2229
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2230
2123
            raise errors.NoSuchFile(f)
2231
2124
        raise
2232
2125
 
2233
 
def file_kind(f, _lstat=os.lstat):
2234
 
    stat_value = file_stat(f, _lstat)
2235
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2236
2126
 
2237
2127
def until_no_eintr(f, *a, **kw):
2238
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2239
 
 
 
2129
    
2240
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2241
2131
    if EINTR does occur.  This is typically only true for low-level operations
2242
2132
    like os.read.  If in any doubt, don't use this.
2257
2147
            raise
2258
2148
 
2259
2149
 
2260
 
@deprecated_function(deprecated_in((2, 2, 0)))
2261
2150
def re_compile_checked(re_string, flags=0, where=""):
2262
2151
    """Return a compiled re, or raise a sensible error.
2263
2152
 
2273
2162
        re_obj = re.compile(re_string, flags)
2274
2163
        re_obj.search("")
2275
2164
        return re_obj
2276
 
    except errors.InvalidPattern, e:
 
2165
    except re.error, e:
2277
2166
        if where:
2278
2167
            where = ' in ' + where
2279
2168
        # despite the name 'error' is a type
2280
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2281
 
            % (where, e.msg))
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
2282
2171
 
2283
2172
 
2284
2173
if sys.platform == "win32":
 
2174
    import msvcrt
2285
2175
    def getchar():
2286
 
        import msvcrt
2287
2176
        return msvcrt.getch()
2288
2177
else:
 
2178
    import tty
 
2179
    import termios
2289
2180
    def getchar():
2290
 
        import tty
2291
 
        import termios
2292
2181
        fd = sys.stdin.fileno()
2293
2182
        settings = termios.tcgetattr(fd)
2294
2183
        try:
2298
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2299
2188
        return ch
2300
2189
 
2301
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2302
2192
    def _local_concurrency():
2303
 
        try:
2304
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2305
 
        except (ValueError, OSError, AttributeError):
2306
 
            return None
 
2193
        concurrency = None
 
2194
        prefix = 'processor'
 
2195
        for line in file('/proc/cpuinfo', 'rb'):
 
2196
            if line.startswith(prefix):
 
2197
                concurrency = int(line[line.find(':')+1:]) + 1
 
2198
        return concurrency
2307
2199
elif sys.platform == 'darwin':
2308
2200
    def _local_concurrency():
2309
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2310
2202
                                stdout=subprocess.PIPE).communicate()[0]
2311
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2312
2204
    def _local_concurrency():
2313
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2314
2206
                                stdout=subprocess.PIPE).communicate()[0]
2342
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2343
2235
    if concurrency is None:
2344
2236
        try:
2345
 
            import multiprocessing
2346
 
            concurrency = multiprocessing.cpu_count()
2347
 
        except (ImportError, NotImplementedError):
2348
 
            # multiprocessing is only available on Python >= 2.6
2349
 
            # and multiprocessing.cpu_count() isn't implemented on all
2350
 
            # platforms
2351
 
            try:
2352
 
                concurrency = _local_concurrency()
2353
 
            except (OSError, IOError):
2354
 
                pass
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2355
2240
    try:
2356
2241
        concurrency = int(concurrency)
2357
2242
    except (TypeError, ValueError):
2378
2263
if sys.platform == 'win32':
2379
2264
    def open_file(filename, mode='r', bufsize=-1):
2380
2265
        """This function is used to override the ``open`` builtin.
2381
 
 
 
2266
        
2382
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2383
2268
        child processes.  Deleting or renaming a closed file opened with this
2384
2269
        function is not blocking child processes.
2417
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2418
2303
else:
2419
2304
    open_file = open
2420
 
 
2421
 
 
2422
 
def available_backup_name(base, exists):
2423
 
    """Find a non-existing backup file name.
2424
 
 
2425
 
    This will *not* create anything, this only return a 'free' entry.  This
2426
 
    should be used for checking names in a directory below a locked
2427
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2428
 
    Leap) and generally discouraged.
2429
 
 
2430
 
    :param base: The base name.
2431
 
 
2432
 
    :param exists: A callable returning True if the path parameter exists.
2433
 
    """
2434
 
    counter = 1
2435
 
    name = "%s.~%d~" % (base, counter)
2436
 
    while exists(name):
2437
 
        counter += 1
2438
 
        name = "%s.~%d~" % (base, counter)
2439
 
    return name
2440
 
 
2441
 
 
2442
 
def set_fd_cloexec(fd):
2443
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2444
 
    support for this is not available.
2445
 
    """
2446
 
    try:
2447
 
        import fcntl
2448
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2449
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2450
 
    except (ImportError, AttributeError):
2451
 
        # Either the fcntl module or specific constants are not present
2452
 
        pass
2453
 
 
2454
 
 
2455
 
def find_executable_on_path(name):
2456
 
    """Finds an executable on the PATH.
2457
 
    
2458
 
    On Windows, this will try to append each extension in the PATHEXT
2459
 
    environment variable to the name, if it cannot be found with the name
2460
 
    as given.
2461
 
    
2462
 
    :param name: The base name of the executable.
2463
 
    :return: The path to the executable found or None.
2464
 
    """
2465
 
    path = os.environ.get('PATH')
2466
 
    if path is None:
2467
 
        return None
2468
 
    path = path.split(os.pathsep)
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)
2473
 
        if ext != '':
2474
 
            if ext.lower() not in exts:
2475
 
                return None
2476
 
            name = base
2477
 
            exts = [ext]
2478
 
    else:
2479
 
        exts = ['']
2480
 
    for ext in exts:
2481
 
        for d in path:
2482
 
            f = os.path.join(d, name) + ext
2483
 
            if os.access(f, os.X_OK):
2484
 
                return f
2485
 
    return None
2486
 
 
2487
 
 
2488
 
def _posix_is_local_pid_dead(pid):
2489
 
    """True if pid doesn't correspond to live process on this machine"""
2490
 
    try:
2491
 
        # Special meaning of unix kill: just check if it's there.
2492
 
        os.kill(pid, 0)
2493
 
    except OSError, e:
2494
 
        if e.errno == errno.ESRCH:
2495
 
            # On this machine, and really not found: as sure as we can be
2496
 
            # that it's dead.
2497
 
            return True
2498
 
        elif e.errno == errno.EPERM:
2499
 
            # exists, though not ours
2500
 
            return False
2501
 
        else:
2502
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2503
 
            # Don't really know.
2504
 
            return False
2505
 
    else:
2506
 
        # Exists and our process: not dead.
2507
 
        return False
2508
 
 
2509
 
if sys.platform == "win32":
2510
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2511
 
else:
2512
 
    is_local_pid_dead = _posix_is_local_pid_dead
2513
 
 
2514
 
 
2515
 
def fdatasync(fileno):
2516
 
    """Flush file contents to disk if possible.
2517
 
    
2518
 
    :param fileno: Integer OS file handle.
2519
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2520
 
    """
2521
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2522
 
    if fn is not None:
2523
 
        fn(fileno)
2524
 
 
2525
 
 
2526
 
def ensure_empty_directory_exists(path, exception_class):
2527
 
    """Make sure a local directory exists and is empty.
2528
 
    
2529
 
    If it does not exist, it is created.  If it exists and is not empty, an
2530
 
    instance of exception_class is raised.
2531
 
    """
2532
 
    try:
2533
 
        os.mkdir(path)
2534
 
    except OSError, e:
2535
 
        if e.errno != errno.EEXIST:
2536
 
            raise
2537
 
        if os.listdir(path) != []:
2538
 
            raise exception_class(path)
2539
 
 
2540
 
 
2541
 
def is_environment_error(evalue):
2542
 
    """True if exception instance is due to a process environment issue
2543
 
 
2544
 
    This includes OSError and IOError, but also other errors that come from
2545
 
    the operating system or core libraries but are not subclasses of those.
2546
 
    """
2547
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2548
 
        return True
2549
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2550
 
        return True
2551
 
    return False