~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-30 12:52:54 UTC
  • mto: This revision was merged to the branch mainline in revision 6418.
  • Revision ID: jelmer@samba.org-20111230125254-igy1abnixsvulfqd
Simplify code a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
23
import sys
23
24
import time
 
25
import codecs
24
26
 
25
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
 
import codecs
28
29
from datetime import datetime
29
 
import errno
30
 
from ntpath import (abspath as _nt_abspath,
31
 
                    join as _nt_join,
32
 
                    normpath as _nt_normpath,
33
 
                    realpath as _nt_realpath,
34
 
                    splitdrive as _nt_splitdrive,
35
 
                    )
 
30
import getpass
 
31
import ntpath
36
32
import posixpath
 
33
import select
 
34
# We need to import both shutil and rmtree as we export the later on posix
 
35
# and need the former on windows
37
36
import shutil
38
 
from shutil import (
39
 
    rmtree,
40
 
    )
 
37
from shutil import rmtree
 
38
import socket
41
39
import subprocess
 
40
# We need to import both tempfile and mkdtemp as we export the later on posix
 
41
# and need the former on windows
42
42
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
43
from tempfile import mkdtemp
46
44
import unicodedata
47
45
 
48
46
from bzrlib import (
49
47
    cache_utf8,
 
48
    config,
50
49
    errors,
 
50
    trace,
51
51
    win32utils,
52
52
    )
 
53
from bzrlib.i18n import gettext
53
54
""")
54
55
 
55
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
 
# of 2.5
57
 
if sys.version_info < (2, 5):
58
 
    import md5 as _mod_md5
59
 
    md5 = _mod_md5.new
60
 
    import sha as _mod_sha
61
 
    sha = _mod_sha.new
62
 
else:
63
 
    from hashlib import (
64
 
        md5,
65
 
        sha1 as sha,
66
 
        )
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
from hashlib import (
 
62
    md5,
 
63
    sha1 as sha,
 
64
    )
67
65
 
68
66
 
69
67
import bzrlib
70
 
from bzrlib import symbol_versioning
71
 
 
 
68
from bzrlib import symbol_versioning, _fs_enc
 
69
 
 
70
 
 
71
# Cross platform wall-clock time functionality with decent resolution.
 
72
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
73
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
74
# synchronized with ``time.time()``, this is only meant to be used to find
 
75
# delta times by subtracting from another call to this function.
 
76
timer_func = time.time
 
77
if sys.platform == 'win32':
 
78
    timer_func = time.clock
72
79
 
73
80
# On win32, O_BINARY is used to indicate the file should
74
81
# be opened in binary mode, rather than text mode.
75
82
# On other platforms, O_BINARY doesn't exist, because
76
83
# they always open in binary mode, so it is okay to
77
 
# OR with 0 on those platforms
 
84
# OR with 0 on those platforms.
 
85
# O_NOINHERIT and O_TEXT exists only on win32 too.
78
86
O_BINARY = getattr(os, 'O_BINARY', 0)
 
87
O_TEXT = getattr(os, 'O_TEXT', 0)
 
88
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
79
89
 
80
90
 
81
91
def get_unicode_argv():
83
93
        user_encoding = get_user_encoding()
84
94
        return [a.decode(user_encoding) for a in sys.argv[1:]]
85
95
    except UnicodeDecodeError:
86
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
87
 
                                                            "encoding." % a))
 
96
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
97
            "application locale.").format(a, user_encoding))
88
98
 
89
99
 
90
100
def make_readonly(filename):
92
102
    mod = os.lstat(filename).st_mode
93
103
    if not stat.S_ISLNK(mod):
94
104
        mod = mod & 0777555
95
 
        os.chmod(filename, mod)
 
105
        chmod_if_possible(filename, mod)
96
106
 
97
107
 
98
108
def make_writable(filename):
99
109
    mod = os.lstat(filename).st_mode
100
110
    if not stat.S_ISLNK(mod):
101
111
        mod = mod | 0200
102
 
        os.chmod(filename, mod)
 
112
        chmod_if_possible(filename, mod)
 
113
 
 
114
 
 
115
def chmod_if_possible(filename, mode):
 
116
    # Set file mode if that can be safely done.
 
117
    # Sometimes even on unix the filesystem won't allow it - see
 
118
    # https://bugs.launchpad.net/bzr/+bug/606537
 
119
    try:
 
120
        # It is probably faster to just do the chmod, rather than
 
121
        # doing a stat, and then trying to compare
 
122
        os.chmod(filename, mode)
 
123
    except (IOError, OSError),e:
 
124
        # Permission/access denied seems to commonly happen on smbfs; there's
 
125
        # probably no point warning about it.
 
126
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
127
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
128
            trace.mutter("ignore error on chmod of %r: %r" % (
 
129
                filename, e))
 
130
            return
 
131
        raise
103
132
 
104
133
 
105
134
def minimum_path_selection(paths):
168
197
    try:
169
198
        return _kind_marker_map[kind]
170
199
    except KeyError:
171
 
        raise errors.BzrError('invalid file kind %r' % kind)
 
200
        # Slightly faster than using .get(, '') when the common case is that
 
201
        # kind will be found
 
202
        return ''
172
203
 
173
204
 
174
205
lexists = getattr(os.path, 'lexists', None)
182
213
            if e.errno == errno.ENOENT:
183
214
                return False;
184
215
            else:
185
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
216
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
186
217
 
187
218
 
188
219
def fancy_rename(old, new, rename_func, unlink_func):
191
222
    :param old: The old path, to rename from
192
223
    :param new: The new path, to rename to
193
224
    :param rename_func: The potentially non-atomic rename function
194
 
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
225
    :param unlink_func: A way to delete the target file if the full rename
 
226
        succeeds
195
227
    """
196
 
 
197
228
    # sftp rename doesn't allow overwriting, so play tricks:
198
229
    base = os.path.basename(new)
199
230
    dirname = os.path.dirname(new)
200
 
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
231
    # callers use different encodings for the paths so the following MUST
 
232
    # respect that. We rely on python upcasting to unicode if new is unicode
 
233
    # and keeping a str if not.
 
234
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
 
235
                                      os.getpid(), rand_chars(10))
201
236
    tmp_name = pathjoin(dirname, tmp_name)
202
237
 
203
238
    # Rename the file out of the way, but keep track if it didn't exist
223
258
    else:
224
259
        file_existed = True
225
260
 
 
261
    failure_exc = None
226
262
    success = False
227
263
    try:
228
264
        try:
234
270
            # source and target may be aliases of each other (e.g. on a
235
271
            # case-insensitive filesystem), so we may have accidentally renamed
236
272
            # source by when we tried to rename target
237
 
            if not (file_existed and e.errno in (None, errno.ENOENT)):
238
 
                raise
 
273
            failure_exc = sys.exc_info()
 
274
            if (file_existed and e.errno in (None, errno.ENOENT)
 
275
                and old.lower() == new.lower()):
 
276
                # source and target are the same file on a case-insensitive
 
277
                # filesystem, so we don't generate an exception
 
278
                failure_exc = None
239
279
    finally:
240
280
        if file_existed:
241
281
            # If the file used to exist, rename it back into place
244
284
                unlink_func(tmp_name)
245
285
            else:
246
286
                rename_func(tmp_name, new)
 
287
    if failure_exc is not None:
 
288
        try:
 
289
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
290
        finally:
 
291
            del failure_exc
247
292
 
248
293
 
249
294
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
250
295
# choke on a Unicode string containing a relative path if
251
296
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
252
297
# string.
253
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
254
298
def _posix_abspath(path):
255
299
    # jam 20060426 rather than encoding to fsencoding
256
300
    # copy posixpath.abspath, but use os.getcwdu instead
257
301
    if not posixpath.isabs(path):
258
302
        path = posixpath.join(getcwd(), path)
259
 
    return posixpath.normpath(path)
 
303
    return _posix_normpath(path)
260
304
 
261
305
 
262
306
def _posix_realpath(path):
263
307
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
264
308
 
265
309
 
 
310
def _posix_normpath(path):
 
311
    path = posixpath.normpath(path)
 
312
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
313
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
314
    # leading slashes must not be simplified to one, and only if there are 3 or
 
315
    # more should they be simplified as one. So we treat the leading 2 slashes
 
316
    # as a special case here by simply removing the first slash, as we consider
 
317
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
318
    # This is not a paranoid precaution, as we notably get paths like this when
 
319
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
320
    if path.startswith('//'):
 
321
        path = path[1:]
 
322
    return path
 
323
 
 
324
 
 
325
def _posix_path_from_environ(key):
 
326
    """Get unicode path from `key` in environment or None if not present
 
327
 
 
328
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
329
    so a path that raises BadFilenameEncoding here may still be accessible.
 
330
    """
 
331
    val = os.environ.get(key, None)
 
332
    if val is None:
 
333
        return val
 
334
    try:
 
335
        return val.decode(_fs_enc)
 
336
    except UnicodeDecodeError:
 
337
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
338
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
339
 
 
340
 
 
341
def _posix_getuser_unicode():
 
342
    """Get username from environment or password database as unicode"""
 
343
    name = getpass.getuser()
 
344
    user_encoding = get_user_encoding()
 
345
    try:
 
346
        return name.decode(user_encoding)
 
347
    except UnicodeDecodeError:
 
348
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
349
            "application locale." % (name, user_encoding))
 
350
 
 
351
 
266
352
def _win32_fixdrive(path):
267
353
    """Force drive letters to be consistent.
268
354
 
272
358
    running python.exe under cmd.exe return capital C:\\
273
359
    running win32 python inside a cygwin shell returns lowercase c:\\
274
360
    """
275
 
    drive, path = _nt_splitdrive(path)
 
361
    drive, path = ntpath.splitdrive(path)
276
362
    return drive.upper() + path
277
363
 
278
364
 
279
365
def _win32_abspath(path):
280
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
281
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
366
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
367
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
282
368
 
283
369
 
284
370
def _win98_abspath(path):
295
381
    #   /path       => C:/path
296
382
    path = unicode(path)
297
383
    # check for absolute path
298
 
    drive = _nt_splitdrive(path)[0]
 
384
    drive = ntpath.splitdrive(path)[0]
299
385
    if drive == '' and path[:2] not in('//','\\\\'):
300
386
        cwd = os.getcwdu()
301
387
        # we cannot simply os.path.join cwd and path
302
388
        # because os.path.join('C:','/path') produce '/path'
303
389
        # and this is incorrect
304
390
        if path[:1] in ('/','\\'):
305
 
            cwd = _nt_splitdrive(cwd)[0]
 
391
            cwd = ntpath.splitdrive(cwd)[0]
306
392
            path = path[1:]
307
393
        path = cwd + '\\' + path
308
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
394
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
309
395
 
310
396
 
311
397
def _win32_realpath(path):
312
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
313
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
398
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
399
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
314
400
 
315
401
 
316
402
def _win32_pathjoin(*args):
317
 
    return _nt_join(*args).replace('\\', '/')
 
403
    return ntpath.join(*args).replace('\\', '/')
318
404
 
319
405
 
320
406
def _win32_normpath(path):
321
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
407
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
322
408
 
323
409
 
324
410
def _win32_getcwd():
356
442
abspath = _posix_abspath
357
443
realpath = _posix_realpath
358
444
pathjoin = os.path.join
359
 
normpath = os.path.normpath
 
445
normpath = _posix_normpath
 
446
path_from_environ = _posix_path_from_environ
 
447
getuser_unicode = _posix_getuser_unicode
360
448
getcwd = os.getcwdu
361
449
rename = os.rename
362
450
dirname = os.path.dirname
363
451
basename = os.path.basename
364
452
split = os.path.split
365
453
splitext = os.path.splitext
366
 
# These were already imported into local scope
 
454
# These were already lazily imported into local scope
367
455
# mkdtemp = tempfile.mkdtemp
368
456
# rmtree = shutil.rmtree
 
457
lstat = os.lstat
 
458
fstat = os.fstat
 
459
 
 
460
def wrap_stat(st):
 
461
    return st
 
462
 
369
463
 
370
464
MIN_ABS_PATHLENGTH = 1
371
465
 
381
475
    getcwd = _win32_getcwd
382
476
    mkdtemp = _win32_mkdtemp
383
477
    rename = _win32_rename
 
478
    try:
 
479
        from bzrlib import _walkdirs_win32
 
480
    except ImportError:
 
481
        pass
 
482
    else:
 
483
        lstat = _walkdirs_win32.lstat
 
484
        fstat = _walkdirs_win32.fstat
 
485
        wrap_stat = _walkdirs_win32.wrap_stat
384
486
 
385
487
    MIN_ABS_PATHLENGTH = 3
386
488
 
404
506
    f = win32utils.get_unicode_argv     # special function or None
405
507
    if f is not None:
406
508
        get_unicode_argv = f
 
509
    path_from_environ = win32utils.get_environ_unicode
 
510
    getuser_unicode = win32utils.get_user_name
407
511
 
408
512
elif sys.platform == 'darwin':
409
513
    getcwd = _mac_getcwd
410
514
 
411
515
 
412
 
def get_terminal_encoding():
 
516
def get_terminal_encoding(trace=False):
413
517
    """Find the best encoding for printing to the screen.
414
518
 
415
519
    This attempts to check both sys.stdout and sys.stdin to see
421
525
 
422
526
    On my standard US Windows XP, the preferred encoding is
423
527
    cp1252, but the console is cp437
 
528
 
 
529
    :param trace: If True trace the selected encoding via mutter().
424
530
    """
425
531
    from bzrlib.trace import mutter
426
532
    output_encoding = getattr(sys.stdout, 'encoding', None)
428
534
        input_encoding = getattr(sys.stdin, 'encoding', None)
429
535
        if not input_encoding:
430
536
            output_encoding = get_user_encoding()
431
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
537
            if trace:
 
538
                mutter('encoding stdout as osutils.get_user_encoding() %r',
432
539
                   output_encoding)
433
540
        else:
434
541
            output_encoding = input_encoding
435
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
542
            if trace:
 
543
                mutter('encoding stdout as sys.stdin encoding %r',
 
544
                    output_encoding)
436
545
    else:
437
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
546
        if trace:
 
547
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
438
548
    if output_encoding == 'cp0':
439
549
        # invalid encoding (cp0 means 'no codepage' on Windows)
440
550
        output_encoding = get_user_encoding()
441
 
        mutter('cp0 is invalid encoding.'
 
551
        if trace:
 
552
            mutter('cp0 is invalid encoding.'
442
553
               ' encoding stdout as osutils.get_user_encoding() %r',
443
554
               output_encoding)
444
555
    # check encoding
470
581
def isdir(f):
471
582
    """True if f is an accessible directory."""
472
583
    try:
473
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
584
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
474
585
    except OSError:
475
586
        return False
476
587
 
478
589
def isfile(f):
479
590
    """True if f is a regular file."""
480
591
    try:
481
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
592
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
482
593
    except OSError:
483
594
        return False
484
595
 
485
596
def islink(f):
486
597
    """True if f is a symlink."""
487
598
    try:
488
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
599
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
489
600
    except OSError:
490
601
        return False
491
602
 
639
750
def sha_file_by_name(fname):
640
751
    """Calculate the SHA1 of a file by reading the full text"""
641
752
    s = sha()
642
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
753
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
643
754
    try:
644
755
        while True:
645
756
            b = os.read(f, 1<<16)
687
798
    return offset.days * 86400 + offset.seconds
688
799
 
689
800
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
801
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
 
802
 
690
803
 
691
804
def format_date(t, offset=0, timezone='original', date_fmt=None,
692
805
                show_offset=True):
706
819
    date_str = time.strftime(date_fmt, tt)
707
820
    return date_str + offset_str
708
821
 
 
822
 
 
823
# Cache of formatted offset strings
 
824
_offset_cache = {}
 
825
 
 
826
 
 
827
def format_date_with_offset_in_original_timezone(t, offset=0,
 
828
    _cache=_offset_cache):
 
829
    """Return a formatted date string in the original timezone.
 
830
 
 
831
    This routine may be faster then format_date.
 
832
 
 
833
    :param t: Seconds since the epoch.
 
834
    :param offset: Timezone offset in seconds east of utc.
 
835
    """
 
836
    if offset is None:
 
837
        offset = 0
 
838
    tt = time.gmtime(t + offset)
 
839
    date_fmt = _default_format_by_weekday_num[tt[6]]
 
840
    date_str = time.strftime(date_fmt, tt)
 
841
    offset_str = _cache.get(offset, None)
 
842
    if offset_str is None:
 
843
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
844
        _cache[offset] = offset_str
 
845
    return date_str + offset_str
 
846
 
 
847
 
709
848
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
710
849
                      show_offset=True):
711
850
    """Return an unicode date string formatted according to the current locale.
725
864
        date_str = date_str.decode(get_user_encoding(), 'replace')
726
865
    return date_str + offset_str
727
866
 
 
867
 
728
868
def _format_date(t, offset, timezone, date_fmt, show_offset):
729
869
    if timezone == 'utc':
730
870
        tt = time.gmtime(t)
802
942
 
803
943
def filesize(f):
804
944
    """Return size of given open file."""
805
 
    return os.fstat(f.fileno())[ST_SIZE]
 
945
    return os.fstat(f.fileno())[stat.ST_SIZE]
806
946
 
807
947
 
808
948
# Define rand_bytes based on platform.
853
993
    rps = []
854
994
    for f in ps:
855
995
        if f == '..':
856
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
996
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
857
997
        elif (f == '.') or (f == ''):
858
998
            pass
859
999
        else:
864
1004
def joinpath(p):
865
1005
    for f in p:
866
1006
        if (f == '..') or (f is None) or (f == ''):
867
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1007
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
868
1008
    return pathjoin(*p)
869
1009
 
870
1010
 
871
1011
def parent_directories(filename):
872
1012
    """Return the list of parent directories, deepest first.
873
 
    
 
1013
 
874
1014
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
875
1015
    """
876
1016
    parents = []
881
1021
    return parents
882
1022
 
883
1023
 
 
1024
_extension_load_failures = []
 
1025
 
 
1026
 
 
1027
def failed_to_load_extension(exception):
 
1028
    """Handle failing to load a binary extension.
 
1029
 
 
1030
    This should be called from the ImportError block guarding the attempt to
 
1031
    import the native extension.  If this function returns, the pure-Python
 
1032
    implementation should be loaded instead::
 
1033
 
 
1034
    >>> try:
 
1035
    >>>     import bzrlib._fictional_extension_pyx
 
1036
    >>> except ImportError, e:
 
1037
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
1038
    >>>     import bzrlib._fictional_extension_py
 
1039
    """
 
1040
    # NB: This docstring is just an example, not a doctest, because doctest
 
1041
    # currently can't cope with the use of lazy imports in this namespace --
 
1042
    # mbp 20090729
 
1043
 
 
1044
    # This currently doesn't report the failure at the time it occurs, because
 
1045
    # they tend to happen very early in startup when we can't check config
 
1046
    # files etc, and also we want to report all failures but not spam the user
 
1047
    # with 10 warnings.
 
1048
    exception_str = str(exception)
 
1049
    if exception_str not in _extension_load_failures:
 
1050
        trace.mutter("failed to load compiled extension: %s" % exception_str)
 
1051
        _extension_load_failures.append(exception_str)
 
1052
 
 
1053
 
 
1054
def report_extension_load_failures():
 
1055
    if not _extension_load_failures:
 
1056
        return
 
1057
    if config.GlobalStack().get('ignore_missing_extensions'):
 
1058
        return
 
1059
    # the warnings framework should by default show this only once
 
1060
    from bzrlib.trace import warning
 
1061
    warning(
 
1062
        "bzr: warning: some compiled extensions could not be loaded; "
 
1063
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
1064
    # we no longer show the specific missing extensions here, because it makes
 
1065
    # the message too long and scary - see
 
1066
    # https://bugs.launchpad.net/bzr/+bug/430529
 
1067
 
 
1068
 
884
1069
try:
885
1070
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
886
 
except ImportError:
 
1071
except ImportError, e:
 
1072
    failed_to_load_extension(e)
887
1073
    from bzrlib._chunks_to_lines_py import chunks_to_lines
888
1074
 
889
1075
 
927
1113
        shutil.copyfile(src, dest)
928
1114
 
929
1115
 
930
 
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
931
 
# Forgiveness than Permission (EAFP) because:
932
 
# - root can damage a solaris file system by using unlink,
933
 
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
934
 
#   EACCES, OSX: EPERM) when invoked on a directory.
935
1116
def delete_any(path):
936
 
    """Delete a file or directory."""
 
1117
    """Delete a file, symlink or directory.
 
1118
 
 
1119
    Will delete even if readonly.
 
1120
    """
 
1121
    try:
 
1122
       _delete_file_or_dir(path)
 
1123
    except (OSError, IOError), e:
 
1124
        if e.errno in (errno.EPERM, errno.EACCES):
 
1125
            # make writable and try again
 
1126
            try:
 
1127
                make_writable(path)
 
1128
            except (OSError, IOError):
 
1129
                pass
 
1130
            _delete_file_or_dir(path)
 
1131
        else:
 
1132
            raise
 
1133
 
 
1134
 
 
1135
def _delete_file_or_dir(path):
 
1136
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
1137
    # Forgiveness than Permission (EAFP) because:
 
1138
    # - root can damage a solaris file system by using unlink,
 
1139
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
1140
    #   EACCES, OSX: EPERM) when invoked on a directory.
937
1141
    if isdir(path): # Takes care of symlinks
938
1142
        os.rmdir(path)
939
1143
    else:
1003
1207
 
1004
1208
 
1005
1209
def relpath(base, path):
1006
 
    """Return path relative to base, or raise exception.
 
1210
    """Return path relative to base, or raise PathNotChild exception.
1007
1211
 
1008
1212
    The path may be either an absolute path or a path relative to the
1009
1213
    current working directory.
1011
1215
    os.path.commonprefix (python2.4) has a bad bug that it works just
1012
1216
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1013
1217
    avoids that problem.
 
1218
 
 
1219
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1220
    PathNotChild exceptions regardless of `path`.
1014
1221
    """
1015
1222
 
1016
1223
    if len(base) < MIN_ABS_PATHLENGTH:
1017
1224
        # must have space for e.g. a drive letter
1018
 
        raise ValueError('%r is too short to calculate a relative path'
 
1225
        raise ValueError(gettext('%r is too short to calculate a relative path')
1019
1226
            % (base,))
1020
1227
 
1021
1228
    rp = abspath(path)
1022
1229
 
1023
1230
    s = []
1024
1231
    head = rp
1025
 
    while len(head) >= len(base):
 
1232
    while True:
 
1233
        if len(head) <= len(base) and head != base:
 
1234
            raise errors.PathNotChild(rp, base)
1026
1235
        if head == base:
1027
1236
            break
1028
 
        head, tail = os.path.split(head)
 
1237
        head, tail = split(head)
1029
1238
        if tail:
1030
 
            s.insert(0, tail)
1031
 
    else:
1032
 
        raise errors.PathNotChild(rp, base)
 
1239
            s.append(tail)
1033
1240
 
1034
1241
    if s:
1035
 
        return pathjoin(*s)
 
1242
        return pathjoin(*reversed(s))
1036
1243
    else:
1037
1244
        return ''
1038
1245
 
1065
1272
    bit_iter = iter(rel.split('/'))
1066
1273
    for bit in bit_iter:
1067
1274
        lbit = bit.lower()
1068
 
        for look in _listdir(current):
 
1275
        try:
 
1276
            next_entries = _listdir(current)
 
1277
        except OSError: # enoent, eperm, etc
 
1278
            # We can't find this in the filesystem, so just append the
 
1279
            # remaining bits.
 
1280
            current = pathjoin(current, bit, *list(bit_iter))
 
1281
            break
 
1282
        for look in next_entries:
1069
1283
            if lbit == look.lower():
1070
1284
                current = pathjoin(current, look)
1071
1285
                break
1075
1289
            # the target of a move, for example).
1076
1290
            current = pathjoin(current, bit, *list(bit_iter))
1077
1291
            break
1078
 
    return current[len(abs_base)+1:]
 
1292
    return current[len(abs_base):].lstrip('/')
1079
1293
 
1080
1294
# XXX - TODO - we need better detection/integration of case-insensitive
1081
1295
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1096
1310
    # but for now, we haven't optimized...
1097
1311
    return [canonical_relpath(base, p) for p in paths]
1098
1312
 
 
1313
 
 
1314
def decode_filename(filename):
 
1315
    """Decode the filename using the filesystem encoding
 
1316
 
 
1317
    If it is unicode, it is returned.
 
1318
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1319
    fails, a errors.BadFilenameEncoding exception is raised.
 
1320
    """
 
1321
    if type(filename) is unicode:
 
1322
        return filename
 
1323
    try:
 
1324
        return filename.decode(_fs_enc)
 
1325
    except UnicodeDecodeError:
 
1326
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1327
 
 
1328
 
1099
1329
def safe_unicode(unicode_or_utf8_string):
1100
1330
    """Coerce unicode_or_utf8_string into unicode.
1101
1331
 
1184
1414
def normalizes_filenames():
1185
1415
    """Return True if this platform normalizes unicode filenames.
1186
1416
 
1187
 
    Mac OSX does, Windows/Linux do not.
 
1417
    Only Mac OSX.
1188
1418
    """
1189
1419
    return _platform_normalizes_filenames
1190
1420
 
1195
1425
    On platforms where the system normalizes filenames (Mac OSX),
1196
1426
    you can access a file by any path which will normalize correctly.
1197
1427
    On platforms where the system does not normalize filenames
1198
 
    (Windows, Linux), you have to access a file by its exact path.
 
1428
    (everything else), you have to access a file by its exact path.
1199
1429
 
1200
1430
    Internally, bzr only supports NFC normalization, since that is
1201
1431
    the standard for XML documents.
1220
1450
    normalized_filename = _inaccessible_normalized_filename
1221
1451
 
1222
1452
 
 
1453
def set_signal_handler(signum, handler, restart_syscall=True):
 
1454
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1455
    on platforms that support that.
 
1456
 
 
1457
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1458
        automatically restart (by calling `signal.siginterrupt(signum,
 
1459
        False)`).  May be ignored if the feature is not available on this
 
1460
        platform or Python version.
 
1461
    """
 
1462
    try:
 
1463
        import signal
 
1464
        siginterrupt = signal.siginterrupt
 
1465
    except ImportError:
 
1466
        # This python implementation doesn't provide signal support, hence no
 
1467
        # handler exists
 
1468
        return None
 
1469
    except AttributeError:
 
1470
        # siginterrupt doesn't exist on this platform, or for this version
 
1471
        # of Python.
 
1472
        siginterrupt = lambda signum, flag: None
 
1473
    if restart_syscall:
 
1474
        def sig_handler(*args):
 
1475
            # Python resets the siginterrupt flag when a signal is
 
1476
            # received.  <http://bugs.python.org/issue8354>
 
1477
            # As a workaround for some cases, set it back the way we want it.
 
1478
            siginterrupt(signum, False)
 
1479
            # Now run the handler function passed to set_signal_handler.
 
1480
            handler(*args)
 
1481
    else:
 
1482
        sig_handler = handler
 
1483
    old_handler = signal.signal(signum, sig_handler)
 
1484
    if restart_syscall:
 
1485
        siginterrupt(signum, False)
 
1486
    return old_handler
 
1487
 
 
1488
 
 
1489
default_terminal_width = 80
 
1490
"""The default terminal width for ttys.
 
1491
 
 
1492
This is defined so that higher levels can share a common fallback value when
 
1493
terminal_width() returns None.
 
1494
"""
 
1495
 
 
1496
# Keep some state so that terminal_width can detect if _terminal_size has
 
1497
# returned a different size since the process started.  See docstring and
 
1498
# comments of terminal_width for details.
 
1499
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1500
_terminal_size_state = 'no_data'
 
1501
_first_terminal_size = None
 
1502
 
1223
1503
def terminal_width():
1224
 
    """Return estimated terminal width."""
1225
 
    if sys.platform == 'win32':
1226
 
        return win32utils.get_console_size()[0]
1227
 
    width = 0
 
1504
    """Return terminal width.
 
1505
 
 
1506
    None is returned if the width can't established precisely.
 
1507
 
 
1508
    The rules are:
 
1509
    - if BZR_COLUMNS is set, returns its value
 
1510
    - if there is no controlling terminal, returns None
 
1511
    - query the OS, if the queried size has changed since the last query,
 
1512
      return its value,
 
1513
    - if COLUMNS is set, returns its value,
 
1514
    - if the OS has a value (even though it's never changed), return its value.
 
1515
 
 
1516
    From there, we need to query the OS to get the size of the controlling
 
1517
    terminal.
 
1518
 
 
1519
    On Unices we query the OS by:
 
1520
    - get termios.TIOCGWINSZ
 
1521
    - if an error occurs or a negative value is obtained, returns None
 
1522
 
 
1523
    On Windows we query the OS by:
 
1524
    - win32utils.get_console_size() decides,
 
1525
    - returns None on error (provided default value)
 
1526
    """
 
1527
    # Note to implementors: if changing the rules for determining the width,
 
1528
    # make sure you've considered the behaviour in these cases:
 
1529
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1530
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1531
    #    0,0.
 
1532
    #  - (add more interesting cases here, if you find any)
 
1533
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1534
    # but we don't want to register a signal handler because it is impossible
 
1535
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1536
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1537
    # time so we can notice if the reported size has changed, which should have
 
1538
    # a similar effect.
 
1539
 
 
1540
    # If BZR_COLUMNS is set, take it, user is always right
 
1541
    # Except if they specified 0 in which case, impose no limit here
 
1542
    try:
 
1543
        width = int(os.environ['BZR_COLUMNS'])
 
1544
    except (KeyError, ValueError):
 
1545
        width = None
 
1546
    if width is not None:
 
1547
        if width > 0:
 
1548
            return width
 
1549
        else:
 
1550
            return None
 
1551
 
 
1552
    isatty = getattr(sys.stdout, 'isatty', None)
 
1553
    if isatty is None or not isatty():
 
1554
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1555
        return None
 
1556
 
 
1557
    # Query the OS
 
1558
    width, height = os_size = _terminal_size(None, None)
 
1559
    global _first_terminal_size, _terminal_size_state
 
1560
    if _terminal_size_state == 'no_data':
 
1561
        _first_terminal_size = os_size
 
1562
        _terminal_size_state = 'unchanged'
 
1563
    elif (_terminal_size_state == 'unchanged' and
 
1564
          _first_terminal_size != os_size):
 
1565
        _terminal_size_state = 'changed'
 
1566
 
 
1567
    # If the OS claims to know how wide the terminal is, and this value has
 
1568
    # ever changed, use that.
 
1569
    if _terminal_size_state == 'changed':
 
1570
        if width is not None and width > 0:
 
1571
            return width
 
1572
 
 
1573
    # If COLUMNS is set, use it.
 
1574
    try:
 
1575
        return int(os.environ['COLUMNS'])
 
1576
    except (KeyError, ValueError):
 
1577
        pass
 
1578
 
 
1579
    # Finally, use an unchanged size from the OS, if we have one.
 
1580
    if _terminal_size_state == 'unchanged':
 
1581
        if width is not None and width > 0:
 
1582
            return width
 
1583
 
 
1584
    # The width could not be determined.
 
1585
    return None
 
1586
 
 
1587
 
 
1588
def _win32_terminal_size(width, height):
 
1589
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
 
1590
    return width, height
 
1591
 
 
1592
 
 
1593
def _ioctl_terminal_size(width, height):
1228
1594
    try:
1229
1595
        import struct, fcntl, termios
1230
1596
        s = struct.pack('HHHH', 0, 0, 0, 0)
1231
1597
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1232
 
        width = struct.unpack('HHHH', x)[1]
1233
 
    except IOError:
 
1598
        height, width = struct.unpack('HHHH', x)[0:2]
 
1599
    except (IOError, AttributeError):
1234
1600
        pass
1235
 
    if width <= 0:
1236
 
        try:
1237
 
            width = int(os.environ['COLUMNS'])
1238
 
        except:
1239
 
            pass
1240
 
    if width <= 0:
1241
 
        width = 80
1242
 
 
1243
 
    return width
 
1601
    return width, height
 
1602
 
 
1603
_terminal_size = None
 
1604
"""Returns the terminal size as (width, height).
 
1605
 
 
1606
:param width: Default value for width.
 
1607
:param height: Default value for height.
 
1608
 
 
1609
This is defined specifically for each OS and query the size of the controlling
 
1610
terminal. If any error occurs, the provided default values should be returned.
 
1611
"""
 
1612
if sys.platform == 'win32':
 
1613
    _terminal_size = _win32_terminal_size
 
1614
else:
 
1615
    _terminal_size = _ioctl_terminal_size
1244
1616
 
1245
1617
 
1246
1618
def supports_executable():
1371
1743
        dirblock = []
1372
1744
        append = dirblock.append
1373
1745
        try:
1374
 
            names = sorted(_listdir(top))
 
1746
            names = sorted(map(decode_filename, _listdir(top)))
1375
1747
        except OSError, e:
1376
1748
            if not _is_error_enotdir(e):
1377
1749
                raise
1431
1803
    """
1432
1804
    global _selected_dir_reader
1433
1805
    if _selected_dir_reader is None:
1434
 
        fs_encoding = _fs_enc.upper()
1435
1806
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1436
1807
            # Win98 doesn't have unicode apis like FindFirstFileW
1437
1808
            # TODO: We possibly could support Win98 by falling back to the
1443
1814
                _selected_dir_reader = Win32ReadDir()
1444
1815
            except ImportError:
1445
1816
                pass
1446
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1447
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1817
        elif _fs_enc in ('utf-8', 'ascii'):
1448
1818
            try:
1449
1819
                from bzrlib._readdir_pyx import UTF8DirReader
1450
1820
                _selected_dir_reader = UTF8DirReader()
1451
 
            except ImportError:
 
1821
            except ImportError, e:
 
1822
                failed_to_load_extension(e)
1452
1823
                pass
1453
1824
 
1454
1825
    if _selected_dir_reader is None:
1565
1936
            real_handlers[kind](abspath, relpath)
1566
1937
 
1567
1938
 
 
1939
def copy_ownership_from_path(dst, src=None):
 
1940
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1941
 
 
1942
    If src is None, the containing directory is used as source. If chown
 
1943
    fails, the error is ignored and a warning is printed.
 
1944
    """
 
1945
    chown = getattr(os, 'chown', None)
 
1946
    if chown is None:
 
1947
        return
 
1948
 
 
1949
    if src == None:
 
1950
        src = os.path.dirname(dst)
 
1951
        if src == '':
 
1952
            src = '.'
 
1953
 
 
1954
    try:
 
1955
        s = os.stat(src)
 
1956
        chown(dst, s.st_uid, s.st_gid)
 
1957
    except OSError, e:
 
1958
        trace.warning(
 
1959
            'Unable to copy ownership from "%s" to "%s". '
 
1960
            'You may want to set it manually.', src, dst)
 
1961
        trace.log_exception_quietly()
 
1962
 
 
1963
 
1568
1964
def path_prefix_key(path):
1569
1965
    """Generate a prefix-order path key for path.
1570
1966
 
1656
2052
    return user_encoding
1657
2053
 
1658
2054
 
 
2055
def get_diff_header_encoding():
 
2056
    return get_terminal_encoding()
 
2057
 
 
2058
 
 
2059
_message_encoding = None
 
2060
 
 
2061
 
 
2062
def get_message_encoding():
 
2063
    """Return the encoding used for messages
 
2064
 
 
2065
    While the message encoding is a general setting it should usually only be
 
2066
    needed for decoding system error strings such as from OSError instances.
 
2067
    """
 
2068
    global _message_encoding
 
2069
    if _message_encoding is None:
 
2070
        if os.name == "posix":
 
2071
            import locale
 
2072
            # This is a process-global setting that can change, but should in
 
2073
            # general just get set once at process startup then be constant.
 
2074
            _message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
 
2075
        else:
 
2076
            # On windows want the result of GetACP() which this boils down to.
 
2077
            _message_encoding = get_user_encoding()
 
2078
    return _message_encoding or "ascii"
 
2079
        
 
2080
 
1659
2081
def get_host_name():
1660
2082
    """Return the current unicode host name.
1661
2083
 
1670
2092
        return socket.gethostname().decode(get_user_encoding())
1671
2093
 
1672
2094
 
1673
 
def recv_all(socket, bytes):
 
2095
# We must not read/write any more than 64k at a time from/to a socket so we
 
2096
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
2097
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
2098
# data at once.
 
2099
MAX_SOCKET_CHUNK = 64 * 1024
 
2100
 
 
2101
_end_of_stream_errors = [errno.ECONNRESET]
 
2102
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2103
    _eno = getattr(errno, _eno, None)
 
2104
    if _eno is not None:
 
2105
        _end_of_stream_errors.append(_eno)
 
2106
del _eno
 
2107
 
 
2108
 
 
2109
def read_bytes_from_socket(sock, report_activity=None,
 
2110
        max_read_size=MAX_SOCKET_CHUNK):
 
2111
    """Read up to max_read_size of bytes from sock and notify of progress.
 
2112
 
 
2113
    Translates "Connection reset by peer" into file-like EOF (return an
 
2114
    empty string rather than raise an error), and repeats the recv if
 
2115
    interrupted by a signal.
 
2116
    """
 
2117
    while 1:
 
2118
        try:
 
2119
            bytes = sock.recv(max_read_size)
 
2120
        except socket.error, e:
 
2121
            eno = e.args[0]
 
2122
            if eno in _end_of_stream_errors:
 
2123
                # The connection was closed by the other side.  Callers expect
 
2124
                # an empty string to signal end-of-stream.
 
2125
                return ""
 
2126
            elif eno == errno.EINTR:
 
2127
                # Retry the interrupted recv.
 
2128
                continue
 
2129
            raise
 
2130
        else:
 
2131
            if report_activity is not None:
 
2132
                report_activity(len(bytes), 'read')
 
2133
            return bytes
 
2134
 
 
2135
 
 
2136
def recv_all(socket, count):
1674
2137
    """Receive an exact number of bytes.
1675
2138
 
1676
2139
    Regular Socket.recv() may return less than the requested number of bytes,
1677
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2140
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1678
2141
    on all platforms, but this should work everywhere.  This will return
1679
2142
    less than the requested amount if the remote end closes.
1680
2143
 
1681
2144
    This isn't optimized and is intended mostly for use in testing.
1682
2145
    """
1683
2146
    b = ''
1684
 
    while len(b) < bytes:
1685
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
2147
    while len(b) < count:
 
2148
        new = read_bytes_from_socket(socket, None, count - len(b))
1686
2149
        if new == '':
1687
2150
            break # eof
1688
2151
        b += new
1689
2152
    return b
1690
2153
 
1691
2154
 
1692
 
def send_all(socket, bytes, report_activity=None):
 
2155
def send_all(sock, bytes, report_activity=None):
1693
2156
    """Send all bytes on a socket.
1694
2157
 
1695
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1696
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2158
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2159
    some platforms, and catches EINTR which may be thrown if the send is
 
2160
    interrupted by a signal.
 
2161
 
 
2162
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2163
    and provides activity reporting.
1697
2164
 
1698
2165
    :param report_activity: Call this as bytes are read, see
1699
2166
        Transport._report_activity
1700
2167
    """
1701
 
    chunk_size = 2**16
1702
 
    for pos in xrange(0, len(bytes), chunk_size):
1703
 
        block = bytes[pos:pos+chunk_size]
1704
 
        if report_activity is not None:
1705
 
            report_activity(len(block), 'write')
1706
 
        until_no_eintr(socket.sendall, block)
 
2168
    sent_total = 0
 
2169
    byte_count = len(bytes)
 
2170
    while sent_total < byte_count:
 
2171
        try:
 
2172
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2173
        except socket.error, e:
 
2174
            if e.args[0] != errno.EINTR:
 
2175
                raise
 
2176
        else:
 
2177
            sent_total += sent
 
2178
            report_activity(sent, 'write')
 
2179
 
 
2180
 
 
2181
def connect_socket(address):
 
2182
    # Slight variation of the socket.create_connection() function (provided by
 
2183
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2184
    # provide it for previous python versions. Also, we don't use the timeout
 
2185
    # parameter (provided by the python implementation) so we don't implement
 
2186
    # it either).
 
2187
    err = socket.error('getaddrinfo returns an empty list')
 
2188
    host, port = address
 
2189
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2190
        af, socktype, proto, canonname, sa = res
 
2191
        sock = None
 
2192
        try:
 
2193
            sock = socket.socket(af, socktype, proto)
 
2194
            sock.connect(sa)
 
2195
            return sock
 
2196
 
 
2197
        except socket.error, err:
 
2198
            # 'err' is now the most recent error
 
2199
            if sock is not None:
 
2200
                sock.close()
 
2201
    raise err
1707
2202
 
1708
2203
 
1709
2204
def dereference_path(path):
1750
2245
    base = dirname(bzrlib.__file__)
1751
2246
    if getattr(sys, 'frozen', None):    # bzr.exe
1752
2247
        base = abspath(pathjoin(base, '..', '..'))
1753
 
    filename = pathjoin(base, resource_relpath)
1754
 
    return open(filename, 'rU').read()
1755
 
 
 
2248
    f = file(pathjoin(base, resource_relpath), "rU")
 
2249
    try:
 
2250
        return f.read()
 
2251
    finally:
 
2252
        f.close()
1756
2253
 
1757
2254
def file_kind_from_stat_mode_thunk(mode):
1758
2255
    global file_kind_from_stat_mode
1760
2257
        try:
1761
2258
            from bzrlib._readdir_pyx import UTF8DirReader
1762
2259
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1763
 
        except ImportError:
 
2260
        except ImportError, e:
 
2261
            # This is one time where we won't warn that an extension failed to
 
2262
            # load. The extension is never available on Windows anyway.
1764
2263
            from bzrlib._readdir_py import (
1765
2264
                _kind_from_mode as file_kind_from_stat_mode
1766
2265
                )
1767
2266
    return file_kind_from_stat_mode(mode)
1768
2267
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1769
2268
 
1770
 
 
1771
 
def file_kind(f, _lstat=os.lstat):
 
2269
def file_stat(f, _lstat=os.lstat):
1772
2270
    try:
1773
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2271
        # XXX cache?
 
2272
        return _lstat(f)
1774
2273
    except OSError, e:
1775
2274
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1776
2275
            raise errors.NoSuchFile(f)
1777
2276
        raise
1778
2277
 
 
2278
def file_kind(f, _lstat=os.lstat):
 
2279
    stat_value = file_stat(f, _lstat)
 
2280
    return file_kind_from_stat_mode(stat_value.st_mode)
1779
2281
 
1780
2282
def until_no_eintr(f, *a, **kw):
1781
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
2283
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2284
 
 
2285
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2286
    if EINTR does occur.  This is typically only true for low-level operations
 
2287
    like os.read.  If in any doubt, don't use this.
 
2288
 
 
2289
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2290
    probably code in the Python standard library and other dependencies that
 
2291
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2292
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2293
    directly controls, but it is not a complete solution.
 
2294
    """
1782
2295
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
1783
2296
    while True:
1784
2297
        try:
1788
2301
                continue
1789
2302
            raise
1790
2303
 
 
2304
 
 
2305
@deprecated_function(deprecated_in((2, 2, 0)))
1791
2306
def re_compile_checked(re_string, flags=0, where=""):
1792
2307
    """Return a compiled re, or raise a sensible error.
1793
2308
 
1803
2318
        re_obj = re.compile(re_string, flags)
1804
2319
        re_obj.search("")
1805
2320
        return re_obj
1806
 
    except re.error, e:
 
2321
    except errors.InvalidPattern, e:
1807
2322
        if where:
1808
2323
            where = ' in ' + where
1809
2324
        # despite the name 'error' is a type
1810
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1811
 
            % (where, re_string, e))
 
2325
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2326
            % (where, e.msg))
1812
2327
 
1813
2328
 
1814
2329
if sys.platform == "win32":
1815
 
    import msvcrt
1816
2330
    def getchar():
 
2331
        import msvcrt
1817
2332
        return msvcrt.getch()
1818
2333
else:
1819
 
    import tty
1820
 
    import termios
1821
2334
    def getchar():
 
2335
        import tty
 
2336
        import termios
1822
2337
        fd = sys.stdin.fileno()
1823
2338
        settings = termios.tcgetattr(fd)
1824
2339
        try:
1828
2343
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
1829
2344
        return ch
1830
2345
 
1831
 
 
1832
 
if sys.platform == 'linux2':
 
2346
if sys.platform.startswith('linux'):
1833
2347
    def _local_concurrency():
1834
 
        concurrency = None
1835
 
        prefix = 'processor'
1836
 
        for line in file('/proc/cpuinfo', 'rb'):
1837
 
            if line.startswith(prefix):
1838
 
                concurrency = int(line[line.find(':')+1:]) + 1
1839
 
        return concurrency
 
2348
        try:
 
2349
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2350
        except (ValueError, OSError, AttributeError):
 
2351
            return None
1840
2352
elif sys.platform == 'darwin':
1841
2353
    def _local_concurrency():
1842
2354
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
1843
2355
                                stdout=subprocess.PIPE).communicate()[0]
1844
 
elif sys.platform[0:7] == 'freebsd':
 
2356
elif "bsd" in sys.platform:
1845
2357
    def _local_concurrency():
1846
2358
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
1847
2359
                                stdout=subprocess.PIPE).communicate()[0]
1868
2380
    anything goes wrong.
1869
2381
    """
1870
2382
    global _cached_local_concurrency
 
2383
 
1871
2384
    if _cached_local_concurrency is not None and use_cache:
1872
2385
        return _cached_local_concurrency
1873
2386
 
1874
 
    try:
1875
 
        concurrency = _local_concurrency()
1876
 
    except (OSError, IOError):
1877
 
        concurrency = None
 
2387
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2388
    if concurrency is None:
 
2389
        try:
 
2390
            import multiprocessing
 
2391
            concurrency = multiprocessing.cpu_count()
 
2392
        except (ImportError, NotImplementedError):
 
2393
            # multiprocessing is only available on Python >= 2.6
 
2394
            # and multiprocessing.cpu_count() isn't implemented on all
 
2395
            # platforms
 
2396
            try:
 
2397
                concurrency = _local_concurrency()
 
2398
            except (OSError, IOError):
 
2399
                pass
1878
2400
    try:
1879
2401
        concurrency = int(concurrency)
1880
2402
    except (TypeError, ValueError):
1882
2404
    if use_cache:
1883
2405
        _cached_concurrency = concurrency
1884
2406
    return concurrency
 
2407
 
 
2408
 
 
2409
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
 
2410
    """A stream writer that doesn't decode str arguments."""
 
2411
 
 
2412
    def __init__(self, encode, stream, errors='strict'):
 
2413
        codecs.StreamWriter.__init__(self, stream, errors)
 
2414
        self.encode = encode
 
2415
 
 
2416
    def write(self, object):
 
2417
        if type(object) is str:
 
2418
            self.stream.write(object)
 
2419
        else:
 
2420
            data, _ = self.encode(object, self.errors)
 
2421
            self.stream.write(data)
 
2422
 
 
2423
if sys.platform == 'win32':
 
2424
    def open_file(filename, mode='r', bufsize=-1):
 
2425
        """This function is used to override the ``open`` builtin.
 
2426
 
 
2427
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2428
        child processes.  Deleting or renaming a closed file opened with this
 
2429
        function is not blocking child processes.
 
2430
        """
 
2431
        writing = 'w' in mode
 
2432
        appending = 'a' in mode
 
2433
        updating = '+' in mode
 
2434
        binary = 'b' in mode
 
2435
 
 
2436
        flags = O_NOINHERIT
 
2437
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2438
        # for flags for each modes.
 
2439
        if binary:
 
2440
            flags |= O_BINARY
 
2441
        else:
 
2442
            flags |= O_TEXT
 
2443
 
 
2444
        if writing:
 
2445
            if updating:
 
2446
                flags |= os.O_RDWR
 
2447
            else:
 
2448
                flags |= os.O_WRONLY
 
2449
            flags |= os.O_CREAT | os.O_TRUNC
 
2450
        elif appending:
 
2451
            if updating:
 
2452
                flags |= os.O_RDWR
 
2453
            else:
 
2454
                flags |= os.O_WRONLY
 
2455
            flags |= os.O_CREAT | os.O_APPEND
 
2456
        else: #reading
 
2457
            if updating:
 
2458
                flags |= os.O_RDWR
 
2459
            else:
 
2460
                flags |= os.O_RDONLY
 
2461
 
 
2462
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2463
else:
 
2464
    open_file = open
 
2465
 
 
2466
 
 
2467
def available_backup_name(base, exists):
 
2468
    """Find a non-existing backup file name.
 
2469
 
 
2470
    This will *not* create anything, this only return a 'free' entry.  This
 
2471
    should be used for checking names in a directory below a locked
 
2472
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2473
    Leap) and generally discouraged.
 
2474
 
 
2475
    :param base: The base name.
 
2476
 
 
2477
    :param exists: A callable returning True if the path parameter exists.
 
2478
    """
 
2479
    counter = 1
 
2480
    name = "%s.~%d~" % (base, counter)
 
2481
    while exists(name):
 
2482
        counter += 1
 
2483
        name = "%s.~%d~" % (base, counter)
 
2484
    return name
 
2485
 
 
2486
 
 
2487
def set_fd_cloexec(fd):
 
2488
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2489
    support for this is not available.
 
2490
    """
 
2491
    try:
 
2492
        import fcntl
 
2493
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2494
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2495
    except (ImportError, AttributeError):
 
2496
        # Either the fcntl module or specific constants are not present
 
2497
        pass
 
2498
 
 
2499
 
 
2500
def find_executable_on_path(name):
 
2501
    """Finds an executable on the PATH.
 
2502
    
 
2503
    On Windows, this will try to append each extension in the PATHEXT
 
2504
    environment variable to the name, if it cannot be found with the name
 
2505
    as given.
 
2506
    
 
2507
    :param name: The base name of the executable.
 
2508
    :return: The path to the executable found or None.
 
2509
    """
 
2510
    path = os.environ.get('PATH')
 
2511
    if path is None:
 
2512
        return None
 
2513
    path = path.split(os.pathsep)
 
2514
    if sys.platform == 'win32':
 
2515
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2516
        exts = [ext.lower() for ext in exts]
 
2517
        base, ext = os.path.splitext(name)
 
2518
        if ext != '':
 
2519
            if ext.lower() not in exts:
 
2520
                return None
 
2521
            name = base
 
2522
            exts = [ext]
 
2523
    else:
 
2524
        exts = ['']
 
2525
    for ext in exts:
 
2526
        for d in path:
 
2527
            f = os.path.join(d, name) + ext
 
2528
            if os.access(f, os.X_OK):
 
2529
                return f
 
2530
    return None
 
2531
 
 
2532
 
 
2533
def _posix_is_local_pid_dead(pid):
 
2534
    """True if pid doesn't correspond to live process on this machine"""
 
2535
    try:
 
2536
        # Special meaning of unix kill: just check if it's there.
 
2537
        os.kill(pid, 0)
 
2538
    except OSError, e:
 
2539
        if e.errno == errno.ESRCH:
 
2540
            # On this machine, and really not found: as sure as we can be
 
2541
            # that it's dead.
 
2542
            return True
 
2543
        elif e.errno == errno.EPERM:
 
2544
            # exists, though not ours
 
2545
            return False
 
2546
        else:
 
2547
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2548
            # Don't really know.
 
2549
            return False
 
2550
    else:
 
2551
        # Exists and our process: not dead.
 
2552
        return False
 
2553
 
 
2554
if sys.platform == "win32":
 
2555
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2556
else:
 
2557
    is_local_pid_dead = _posix_is_local_pid_dead
 
2558
 
 
2559
 
 
2560
def fdatasync(fileno):
 
2561
    """Flush file contents to disk if possible.
 
2562
    
 
2563
    :param fileno: Integer OS file handle.
 
2564
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2565
    """
 
2566
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2567
    if fn is not None:
 
2568
        fn(fileno)
 
2569
 
 
2570
 
 
2571
def ensure_empty_directory_exists(path, exception_class):
 
2572
    """Make sure a local directory exists and is empty.
 
2573
    
 
2574
    If it does not exist, it is created.  If it exists and is not empty, an
 
2575
    instance of exception_class is raised.
 
2576
    """
 
2577
    try:
 
2578
        os.mkdir(path)
 
2579
    except OSError, e:
 
2580
        if e.errno != errno.EEXIST:
 
2581
            raise
 
2582
        if os.listdir(path) != []:
 
2583
            raise exception_class(path)
 
2584
 
 
2585
 
 
2586
def is_environment_error(evalue):
 
2587
    """True if exception instance is due to a process environment issue
 
2588
 
 
2589
    This includes OSError and IOError, but also other errors that come from
 
2590
    the operating system or core libraries but are not subclasses of those.
 
2591
    """
 
2592
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2593
        return True
 
2594
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2595
        return True
 
2596
    return False