~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
22
import sys
24
23
import time
25
 
import codecs
26
24
 
27
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
 
27
import codecs
29
28
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
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
                    )
33
36
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
37
import shutil
38
 
from shutil import rmtree
39
 
import socket
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
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
 
    trace,
52
51
    win32utils,
53
52
    )
54
 
from bzrlib.i18n import gettext
55
53
""")
56
54
 
57
 
from bzrlib.symbol_versioning import (
58
 
    DEPRECATED_PARAMETER,
59
 
    deprecated_function,
60
 
    deprecated_in,
61
 
    deprecated_passed,
62
 
    warn as warn_deprecated,
63
 
    )
64
 
 
65
 
from hashlib import (
66
 
    md5,
67
 
    sha1 as sha,
68
 
    )
 
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
        )
69
67
 
70
68
 
71
69
import bzrlib
72
 
from bzrlib import symbol_versioning, _fs_enc
73
 
 
74
 
 
75
 
# Cross platform wall-clock time functionality with decent resolution.
76
 
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
77
 
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
78
 
# synchronized with ``time.time()``, this is only meant to be used to find
79
 
# delta times by subtracting from another call to this function.
80
 
timer_func = time.time
81
 
if sys.platform == 'win32':
82
 
    timer_func = time.clock
 
70
from bzrlib import symbol_versioning
 
71
 
83
72
 
84
73
# On win32, O_BINARY is used to indicate the file should
85
74
# be opened in binary mode, rather than text mode.
86
75
# On other platforms, O_BINARY doesn't exist, because
87
76
# they always open in binary mode, so it is okay to
88
 
# OR with 0 on those platforms.
89
 
# O_NOINHERIT and O_TEXT exists only on win32 too.
 
77
# OR with 0 on those platforms
90
78
O_BINARY = getattr(os, 'O_BINARY', 0)
91
 
O_TEXT = getattr(os, 'O_TEXT', 0)
92
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
93
79
 
94
80
 
95
81
def get_unicode_argv():
97
83
        user_encoding = get_user_encoding()
98
84
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
85
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
            "application locale.").format(a, user_encoding))
 
86
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
87
                                                            "encoding." % a))
102
88
 
103
89
 
104
90
def make_readonly(filename):
106
92
    mod = os.lstat(filename).st_mode
107
93
    if not stat.S_ISLNK(mod):
108
94
        mod = mod & 0777555
109
 
        chmod_if_possible(filename, mod)
 
95
        os.chmod(filename, mod)
110
96
 
111
97
 
112
98
def make_writable(filename):
113
99
    mod = os.lstat(filename).st_mode
114
100
    if not stat.S_ISLNK(mod):
115
101
        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
 
102
        os.chmod(filename, mod)
136
103
 
137
104
 
138
105
def minimum_path_selection(paths):
201
168
    try:
202
169
        return _kind_marker_map[kind]
203
170
    except KeyError:
204
 
        # Slightly faster than using .get(, '') when the common case is that
205
 
        # kind will be found
206
 
        return ''
 
171
        raise errors.BzrError('invalid file kind %r' % kind)
207
172
 
208
173
 
209
174
lexists = getattr(os.path, 'lexists', None)
217
182
            if e.errno == errno.ENOENT:
218
183
                return False;
219
184
            else:
220
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
185
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
221
186
 
222
187
 
223
188
def fancy_rename(old, new, rename_func, unlink_func):
226
191
    :param old: The old path, to rename from
227
192
    :param new: The new path, to rename to
228
193
    :param rename_func: The potentially non-atomic rename function
229
 
    :param unlink_func: A way to delete the target file if the full rename
230
 
        succeeds
 
194
    :param unlink_func: A way to delete the target file if the full rename succeeds
231
195
    """
 
196
 
232
197
    # sftp rename doesn't allow overwriting, so play tricks:
233
198
    base = os.path.basename(new)
234
199
    dirname = os.path.dirname(new)
235
 
    # callers use different encodings for the paths so the following MUST
236
 
    # respect that. We rely on python upcasting to unicode if new is unicode
237
 
    # and keeping a str if not.
238
 
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
239
 
                                      os.getpid(), rand_chars(10))
 
200
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
240
201
    tmp_name = pathjoin(dirname, tmp_name)
241
202
 
242
203
    # Rename the file out of the way, but keep track if it didn't exist
262
223
    else:
263
224
        file_existed = True
264
225
 
265
 
    failure_exc = None
266
226
    success = False
267
227
    try:
268
228
        try:
274
234
            # source and target may be aliases of each other (e.g. on a
275
235
            # case-insensitive filesystem), so we may have accidentally renamed
276
236
            # source by when we tried to rename target
277
 
            failure_exc = sys.exc_info()
278
 
            if (file_existed and e.errno in (None, errno.ENOENT)
279
 
                and old.lower() == new.lower()):
280
 
                # source and target are the same file on a case-insensitive
281
 
                # filesystem, so we don't generate an exception
282
 
                failure_exc = None
 
237
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
238
                raise
283
239
    finally:
284
240
        if file_existed:
285
241
            # If the file used to exist, rename it back into place
288
244
                unlink_func(tmp_name)
289
245
            else:
290
246
                rename_func(tmp_name, new)
291
 
    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
296
247
 
297
248
 
298
249
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
250
# choke on a Unicode string containing a relative path if
300
251
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
252
# string.
 
253
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
254
def _posix_abspath(path):
303
255
    # jam 20060426 rather than encoding to fsencoding
304
256
    # copy posixpath.abspath, but use os.getcwdu instead
305
257
    if not posixpath.isabs(path):
306
258
        path = posixpath.join(getcwd(), path)
307
 
    return _posix_normpath(path)
 
259
    return posixpath.normpath(path)
308
260
 
309
261
 
310
262
def _posix_realpath(path):
311
263
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
264
 
313
265
 
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_get_home_dir():
346
 
    """Get the home directory of the current user as a unicode path"""
347
 
    path = posixpath.expanduser("~")
348
 
    try:
349
 
        return path.decode(_fs_enc)
350
 
    except UnicodeDecodeError:
351
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
352
 
 
353
 
 
354
 
def _posix_getuser_unicode():
355
 
    """Get username from environment or password database as unicode"""
356
 
    name = getpass.getuser()
357
 
    user_encoding = get_user_encoding()
358
 
    try:
359
 
        return name.decode(user_encoding)
360
 
    except UnicodeDecodeError:
361
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
362
 
            "application locale." % (name, user_encoding))
363
 
 
364
 
 
365
266
def _win32_fixdrive(path):
366
267
    """Force drive letters to be consistent.
367
268
 
371
272
    running python.exe under cmd.exe return capital C:\\
372
273
    running win32 python inside a cygwin shell returns lowercase c:\\
373
274
    """
374
 
    drive, path = ntpath.splitdrive(path)
 
275
    drive, path = _nt_splitdrive(path)
375
276
    return drive.upper() + path
376
277
 
377
278
 
378
279
def _win32_abspath(path):
379
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
380
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
280
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
281
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
381
282
 
382
283
 
383
284
def _win98_abspath(path):
394
295
    #   /path       => C:/path
395
296
    path = unicode(path)
396
297
    # check for absolute path
397
 
    drive = ntpath.splitdrive(path)[0]
 
298
    drive = _nt_splitdrive(path)[0]
398
299
    if drive == '' and path[:2] not in('//','\\\\'):
399
300
        cwd = os.getcwdu()
400
301
        # we cannot simply os.path.join cwd and path
401
302
        # because os.path.join('C:','/path') produce '/path'
402
303
        # and this is incorrect
403
304
        if path[:1] in ('/','\\'):
404
 
            cwd = ntpath.splitdrive(cwd)[0]
 
305
            cwd = _nt_splitdrive(cwd)[0]
405
306
            path = path[1:]
406
307
        path = cwd + '\\' + path
407
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
308
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
408
309
 
409
310
 
410
311
def _win32_realpath(path):
411
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
412
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
312
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
313
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
413
314
 
414
315
 
415
316
def _win32_pathjoin(*args):
416
 
    return ntpath.join(*args).replace('\\', '/')
 
317
    return _nt_join(*args).replace('\\', '/')
417
318
 
418
319
 
419
320
def _win32_normpath(path):
420
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
321
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
421
322
 
422
323
 
423
324
def _win32_getcwd():
450
351
    return unicodedata.normalize('NFC', os.getcwdu())
451
352
 
452
353
 
453
 
def _rename_wrap_exception(rename_func):
454
 
    """Adds extra information to any exceptions that come from rename().
455
 
 
456
 
    The exception has an updated message and 'old_filename' and 'new_filename'
457
 
    attributes.
458
 
    """
459
 
 
460
 
    def _rename_wrapper(old, new):
461
 
        try:
462
 
            rename_func(old, new)
463
 
        except OSError, e:
464
 
            detailed_error = OSError(e.errno, e.strerror +
465
 
                                " [occurred when renaming '%s' to '%s']" %
466
 
                                (old, new))
467
 
            detailed_error.old_filename = old
468
 
            detailed_error.new_filename = new
469
 
            raise detailed_error
470
 
 
471
 
    return _rename_wrapper
472
 
 
473
 
# Default rename wraps os.rename()
474
 
rename = _rename_wrap_exception(os.rename)
475
 
 
476
354
# Default is to just use the python builtins, but these can be rebound on
477
355
# particular platforms.
478
356
abspath = _posix_abspath
479
357
realpath = _posix_realpath
480
358
pathjoin = os.path.join
481
 
normpath = _posix_normpath
482
 
path_from_environ = _posix_path_from_environ
483
 
_get_home_dir = _posix_get_home_dir
484
 
getuser_unicode = _posix_getuser_unicode
 
359
normpath = os.path.normpath
485
360
getcwd = os.getcwdu
 
361
rename = os.rename
486
362
dirname = os.path.dirname
487
363
basename = os.path.basename
488
364
split = os.path.split
489
365
splitext = os.path.splitext
490
 
# These were already lazily imported into local scope
 
366
# These were already imported into local scope
491
367
# mkdtemp = tempfile.mkdtemp
492
368
# rmtree = shutil.rmtree
493
 
lstat = os.lstat
494
 
fstat = os.fstat
495
 
 
496
 
def wrap_stat(st):
497
 
    return st
498
 
 
499
369
 
500
370
MIN_ABS_PATHLENGTH = 1
501
371
 
510
380
    normpath = _win32_normpath
511
381
    getcwd = _win32_getcwd
512
382
    mkdtemp = _win32_mkdtemp
513
 
    rename = _rename_wrap_exception(_win32_rename)
514
 
    try:
515
 
        from bzrlib import _walkdirs_win32
516
 
    except ImportError:
517
 
        pass
518
 
    else:
519
 
        lstat = _walkdirs_win32.lstat
520
 
        fstat = _walkdirs_win32.fstat
521
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
383
    rename = _win32_rename
522
384
 
523
385
    MIN_ABS_PATHLENGTH = 3
524
386
 
542
404
    f = win32utils.get_unicode_argv     # special function or None
543
405
    if f is not None:
544
406
        get_unicode_argv = f
545
 
    path_from_environ = win32utils.get_environ_unicode
546
 
    _get_home_dir = win32utils.get_home_location
547
 
    getuser_unicode = win32utils.get_user_name
548
407
 
549
408
elif sys.platform == 'darwin':
550
409
    getcwd = _mac_getcwd
551
410
 
552
411
 
553
 
def get_terminal_encoding(trace=False):
 
412
def get_terminal_encoding():
554
413
    """Find the best encoding for printing to the screen.
555
414
 
556
415
    This attempts to check both sys.stdout and sys.stdin to see
562
421
 
563
422
    On my standard US Windows XP, the preferred encoding is
564
423
    cp1252, but the console is cp437
565
 
 
566
 
    :param trace: If True trace the selected encoding via mutter().
567
424
    """
568
425
    from bzrlib.trace import mutter
569
426
    output_encoding = getattr(sys.stdout, 'encoding', None)
571
428
        input_encoding = getattr(sys.stdin, 'encoding', None)
572
429
        if not input_encoding:
573
430
            output_encoding = get_user_encoding()
574
 
            if trace:
575
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
431
            mutter('encoding stdout as osutils.get_user_encoding() %r',
576
432
                   output_encoding)
577
433
        else:
578
434
            output_encoding = input_encoding
579
 
            if trace:
580
 
                mutter('encoding stdout as sys.stdin encoding %r',
581
 
                    output_encoding)
 
435
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
582
436
    else:
583
 
        if trace:
584
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
437
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
585
438
    if output_encoding == 'cp0':
586
439
        # invalid encoding (cp0 means 'no codepage' on Windows)
587
440
        output_encoding = get_user_encoding()
588
 
        if trace:
589
 
            mutter('cp0 is invalid encoding.'
 
441
        mutter('cp0 is invalid encoding.'
590
442
               ' encoding stdout as osutils.get_user_encoding() %r',
591
443
               output_encoding)
592
444
    # check encoding
618
470
def isdir(f):
619
471
    """True if f is an accessible directory."""
620
472
    try:
621
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
473
        return S_ISDIR(os.lstat(f)[ST_MODE])
622
474
    except OSError:
623
475
        return False
624
476
 
626
478
def isfile(f):
627
479
    """True if f is a regular file."""
628
480
    try:
629
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
481
        return S_ISREG(os.lstat(f)[ST_MODE])
630
482
    except OSError:
631
483
        return False
632
484
 
633
485
def islink(f):
634
486
    """True if f is a symlink."""
635
487
    try:
636
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
488
        return S_ISLNK(os.lstat(f)[ST_MODE])
637
489
    except OSError:
638
490
        return False
639
491
 
787
639
def sha_file_by_name(fname):
788
640
    """Calculate the SHA1 of a file by reading the full text"""
789
641
    s = sha()
790
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
642
    f = os.open(fname, os.O_RDONLY | O_BINARY)
791
643
    try:
792
644
        while True:
793
645
            b = os.read(f, 1<<16)
835
687
    return offset.days * 86400 + offset.seconds
836
688
 
837
689
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
838
 
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
839
 
 
840
690
 
841
691
def format_date(t, offset=0, timezone='original', date_fmt=None,
842
692
                show_offset=True):
856
706
    date_str = time.strftime(date_fmt, tt)
857
707
    return date_str + offset_str
858
708
 
859
 
 
860
 
# Cache of formatted offset strings
861
 
_offset_cache = {}
862
 
 
863
 
 
864
 
def format_date_with_offset_in_original_timezone(t, offset=0,
865
 
    _cache=_offset_cache):
866
 
    """Return a formatted date string in the original timezone.
867
 
 
868
 
    This routine may be faster then format_date.
869
 
 
870
 
    :param t: Seconds since the epoch.
871
 
    :param offset: Timezone offset in seconds east of utc.
872
 
    """
873
 
    if offset is None:
874
 
        offset = 0
875
 
    tt = time.gmtime(t + offset)
876
 
    date_fmt = _default_format_by_weekday_num[tt[6]]
877
 
    date_str = time.strftime(date_fmt, tt)
878
 
    offset_str = _cache.get(offset, None)
879
 
    if offset_str is None:
880
 
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
881
 
        _cache[offset] = offset_str
882
 
    return date_str + offset_str
883
 
 
884
 
 
885
709
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
886
710
                      show_offset=True):
887
711
    """Return an unicode date string formatted according to the current locale.
901
725
        date_str = date_str.decode(get_user_encoding(), 'replace')
902
726
    return date_str + offset_str
903
727
 
904
 
 
905
728
def _format_date(t, offset, timezone, date_fmt, show_offset):
906
729
    if timezone == 'utc':
907
730
        tt = time.gmtime(t)
979
802
 
980
803
def filesize(f):
981
804
    """Return size of given open file."""
982
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
983
 
 
984
 
 
985
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
986
 
# override if it doesn't work. Avoid checking on windows where there is
987
 
# significant initialisation cost that can be avoided for some bzr calls.
988
 
 
989
 
rand_bytes = os.urandom
990
 
 
991
 
if rand_bytes.__module__ != "nt":
 
805
    return os.fstat(f.fileno())[ST_SIZE]
 
806
 
 
807
 
 
808
# Define rand_bytes based on platform.
 
809
try:
 
810
    # Python 2.4 and later have os.urandom,
 
811
    # but it doesn't work on some arches
 
812
    os.urandom(1)
 
813
    rand_bytes = os.urandom
 
814
except (NotImplementedError, AttributeError):
 
815
    # If python doesn't have os.urandom, or it doesn't work,
 
816
    # then try to first pull random data from /dev/urandom
992
817
    try:
993
 
        rand_bytes(1)
994
 
    except NotImplementedError:
 
818
        rand_bytes = file('/dev/urandom', 'rb').read
 
819
    # Otherwise, use this hack as a last resort
 
820
    except (IOError, OSError):
995
821
        # not well seeded, but better than nothing
996
822
        def rand_bytes(n):
997
823
            import random
1027
853
    rps = []
1028
854
    for f in ps:
1029
855
        if f == '..':
1030
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
856
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1031
857
        elif (f == '.') or (f == ''):
1032
858
            pass
1033
859
        else:
1038
864
def joinpath(p):
1039
865
    for f in p:
1040
866
        if (f == '..') or (f is None) or (f == ''):
1041
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
867
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1042
868
    return pathjoin(*p)
1043
869
 
1044
870
 
1045
871
def parent_directories(filename):
1046
872
    """Return the list of parent directories, deepest first.
1047
 
 
 
873
    
1048
874
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1049
875
    """
1050
876
    parents = []
1055
881
    return parents
1056
882
 
1057
883
 
1058
 
_extension_load_failures = []
1059
 
 
1060
 
 
1061
 
def failed_to_load_extension(exception):
1062
 
    """Handle failing to load a binary extension.
1063
 
 
1064
 
    This should be called from the ImportError block guarding the attempt to
1065
 
    import the native extension.  If this function returns, the pure-Python
1066
 
    implementation should be loaded instead::
1067
 
 
1068
 
    >>> try:
1069
 
    >>>     import bzrlib._fictional_extension_pyx
1070
 
    >>> except ImportError, e:
1071
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
1072
 
    >>>     import bzrlib._fictional_extension_py
1073
 
    """
1074
 
    # NB: This docstring is just an example, not a doctest, because doctest
1075
 
    # currently can't cope with the use of lazy imports in this namespace --
1076
 
    # mbp 20090729
1077
 
 
1078
 
    # This currently doesn't report the failure at the time it occurs, because
1079
 
    # they tend to happen very early in startup when we can't check config
1080
 
    # files etc, and also we want to report all failures but not spam the user
1081
 
    # with 10 warnings.
1082
 
    exception_str = str(exception)
1083
 
    if exception_str not in _extension_load_failures:
1084
 
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1085
 
        _extension_load_failures.append(exception_str)
1086
 
 
1087
 
 
1088
 
def report_extension_load_failures():
1089
 
    if not _extension_load_failures:
1090
 
        return
1091
 
    if config.GlobalStack().get('ignore_missing_extensions'):
1092
 
        return
1093
 
    # the warnings framework should by default show this only once
1094
 
    from bzrlib.trace import warning
1095
 
    warning(
1096
 
        "bzr: warning: some compiled extensions could not be loaded; "
1097
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1098
 
    # we no longer show the specific missing extensions here, because it makes
1099
 
    # the message too long and scary - see
1100
 
    # https://bugs.launchpad.net/bzr/+bug/430529
1101
 
 
1102
 
 
1103
884
try:
1104
885
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1105
 
except ImportError, e:
1106
 
    failed_to_load_extension(e)
 
886
except ImportError:
1107
887
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1108
888
 
1109
889
 
1148
928
 
1149
929
 
1150
930
def delete_any(path):
1151
 
    """Delete a file, symlink or directory.
1152
 
 
 
931
    """Delete a file, symlink or directory.  
 
932
    
1153
933
    Will delete even if readonly.
1154
934
    """
1155
935
    try:
1241
1021
 
1242
1022
 
1243
1023
def relpath(base, path):
1244
 
    """Return path relative to base, or raise PathNotChild exception.
 
1024
    """Return path relative to base, or raise exception.
1245
1025
 
1246
1026
    The path may be either an absolute path or a path relative to the
1247
1027
    current working directory.
1249
1029
    os.path.commonprefix (python2.4) has a bad bug that it works just
1250
1030
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1251
1031
    avoids that problem.
1252
 
 
1253
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1254
 
    PathNotChild exceptions regardless of `path`.
1255
1032
    """
1256
1033
 
1257
1034
    if len(base) < MIN_ABS_PATHLENGTH:
1258
1035
        # must have space for e.g. a drive letter
1259
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1036
        raise ValueError('%r is too short to calculate a relative path'
1260
1037
            % (base,))
1261
1038
 
1262
1039
    rp = abspath(path)
1344
1121
    # but for now, we haven't optimized...
1345
1122
    return [canonical_relpath(base, p) for p in paths]
1346
1123
 
1347
 
 
1348
 
def decode_filename(filename):
1349
 
    """Decode the filename using the filesystem encoding
1350
 
 
1351
 
    If it is unicode, it is returned.
1352
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1353
 
    fails, a errors.BadFilenameEncoding exception is raised.
1354
 
    """
1355
 
    if type(filename) is unicode:
1356
 
        return filename
1357
 
    try:
1358
 
        return filename.decode(_fs_enc)
1359
 
    except UnicodeDecodeError:
1360
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1361
 
 
1362
 
 
1363
1124
def safe_unicode(unicode_or_utf8_string):
1364
1125
    """Coerce unicode_or_utf8_string into unicode.
1365
1126
 
1448
1209
def normalizes_filenames():
1449
1210
    """Return True if this platform normalizes unicode filenames.
1450
1211
 
1451
 
    Only Mac OSX.
 
1212
    Mac OSX does, Windows/Linux do not.
1452
1213
    """
1453
1214
    return _platform_normalizes_filenames
1454
1215
 
1459
1220
    On platforms where the system normalizes filenames (Mac OSX),
1460
1221
    you can access a file by any path which will normalize correctly.
1461
1222
    On platforms where the system does not normalize filenames
1462
 
    (everything else), you have to access a file by its exact path.
 
1223
    (Windows, Linux), you have to access a file by its exact path.
1463
1224
 
1464
1225
    Internally, bzr only supports NFC normalization, since that is
1465
1226
    the standard for XML documents.
1484
1245
    normalized_filename = _inaccessible_normalized_filename
1485
1246
 
1486
1247
 
1487
 
def set_signal_handler(signum, handler, restart_syscall=True):
1488
 
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
1489
 
    on platforms that support that.
1490
 
 
1491
 
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
1492
 
        automatically restart (by calling `signal.siginterrupt(signum,
1493
 
        False)`).  May be ignored if the feature is not available on this
1494
 
        platform or Python version.
1495
 
    """
1496
 
    try:
1497
 
        import signal
1498
 
        siginterrupt = signal.siginterrupt
1499
 
    except ImportError:
1500
 
        # This python implementation doesn't provide signal support, hence no
1501
 
        # handler exists
1502
 
        return None
1503
 
    except AttributeError:
1504
 
        # siginterrupt doesn't exist on this platform, or for this version
1505
 
        # of Python.
1506
 
        siginterrupt = lambda signum, flag: None
1507
 
    if restart_syscall:
1508
 
        def sig_handler(*args):
1509
 
            # Python resets the siginterrupt flag when a signal is
1510
 
            # received.  <http://bugs.python.org/issue8354>
1511
 
            # As a workaround for some cases, set it back the way we want it.
1512
 
            siginterrupt(signum, False)
1513
 
            # Now run the handler function passed to set_signal_handler.
1514
 
            handler(*args)
1515
 
    else:
1516
 
        sig_handler = handler
1517
 
    old_handler = signal.signal(signum, sig_handler)
1518
 
    if restart_syscall:
1519
 
        siginterrupt(signum, False)
1520
 
    return old_handler
1521
 
 
1522
 
 
1523
 
default_terminal_width = 80
1524
 
"""The default terminal width for ttys.
1525
 
 
1526
 
This is defined so that higher levels can share a common fallback value when
1527
 
terminal_width() returns None.
1528
 
"""
1529
 
 
1530
 
# Keep some state so that terminal_width can detect if _terminal_size has
1531
 
# returned a different size since the process started.  See docstring and
1532
 
# comments of terminal_width for details.
1533
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1534
 
_terminal_size_state = 'no_data'
1535
 
_first_terminal_size = None
1536
 
 
1537
1248
def terminal_width():
1538
 
    """Return terminal width.
1539
 
 
1540
 
    None is returned if the width can't established precisely.
1541
 
 
1542
 
    The rules are:
1543
 
    - if BZR_COLUMNS is set, returns its value
1544
 
    - if there is no controlling terminal, returns None
1545
 
    - query the OS, if the queried size has changed since the last query,
1546
 
      return its value,
1547
 
    - if COLUMNS is set, returns its value,
1548
 
    - if the OS has a value (even though it's never changed), return its value.
1549
 
 
1550
 
    From there, we need to query the OS to get the size of the controlling
1551
 
    terminal.
1552
 
 
1553
 
    On Unices we query the OS by:
1554
 
    - get termios.TIOCGWINSZ
1555
 
    - if an error occurs or a negative value is obtained, returns None
1556
 
 
1557
 
    On Windows we query the OS by:
1558
 
    - win32utils.get_console_size() decides,
1559
 
    - returns None on error (provided default value)
1560
 
    """
1561
 
    # Note to implementors: if changing the rules for determining the width,
1562
 
    # make sure you've considered the behaviour in these cases:
1563
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1564
 
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1565
 
    #    0,0.
1566
 
    #  - (add more interesting cases here, if you find any)
1567
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1568
 
    # but we don't want to register a signal handler because it is impossible
1569
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1570
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1571
 
    # time so we can notice if the reported size has changed, which should have
1572
 
    # a similar effect.
1573
 
 
1574
 
    # If BZR_COLUMNS is set, take it, user is always right
1575
 
    # Except if they specified 0 in which case, impose no limit here
1576
 
    try:
1577
 
        width = int(os.environ['BZR_COLUMNS'])
1578
 
    except (KeyError, ValueError):
1579
 
        width = None
1580
 
    if width is not None:
1581
 
        if width > 0:
1582
 
            return width
1583
 
        else:
1584
 
            return None
1585
 
 
1586
 
    isatty = getattr(sys.stdout, 'isatty', None)
1587
 
    if isatty is None or not isatty():
1588
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1589
 
        return None
1590
 
 
1591
 
    # Query the OS
1592
 
    width, height = os_size = _terminal_size(None, None)
1593
 
    global _first_terminal_size, _terminal_size_state
1594
 
    if _terminal_size_state == 'no_data':
1595
 
        _first_terminal_size = os_size
1596
 
        _terminal_size_state = 'unchanged'
1597
 
    elif (_terminal_size_state == 'unchanged' and
1598
 
          _first_terminal_size != os_size):
1599
 
        _terminal_size_state = 'changed'
1600
 
 
1601
 
    # If the OS claims to know how wide the terminal is, and this value has
1602
 
    # ever changed, use that.
1603
 
    if _terminal_size_state == 'changed':
1604
 
        if width is not None and width > 0:
1605
 
            return width
1606
 
 
1607
 
    # If COLUMNS is set, use it.
1608
 
    try:
1609
 
        return int(os.environ['COLUMNS'])
1610
 
    except (KeyError, ValueError):
1611
 
        pass
1612
 
 
1613
 
    # Finally, use an unchanged size from the OS, if we have one.
1614
 
    if _terminal_size_state == 'unchanged':
1615
 
        if width is not None and width > 0:
1616
 
            return width
1617
 
 
1618
 
    # The width could not be determined.
1619
 
    return None
1620
 
 
1621
 
 
1622
 
def _win32_terminal_size(width, height):
1623
 
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1624
 
    return width, height
1625
 
 
1626
 
 
1627
 
def _ioctl_terminal_size(width, height):
 
1249
    """Return estimated terminal width."""
 
1250
    if sys.platform == 'win32':
 
1251
        return win32utils.get_console_size()[0]
 
1252
    width = 0
1628
1253
    try:
1629
1254
        import struct, fcntl, termios
1630
1255
        s = struct.pack('HHHH', 0, 0, 0, 0)
1631
1256
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1632
 
        height, width = struct.unpack('HHHH', x)[0:2]
1633
 
    except (IOError, AttributeError):
 
1257
        width = struct.unpack('HHHH', x)[1]
 
1258
    except IOError:
1634
1259
        pass
1635
 
    return width, height
1636
 
 
1637
 
_terminal_size = None
1638
 
"""Returns the terminal size as (width, height).
1639
 
 
1640
 
:param width: Default value for width.
1641
 
:param height: Default value for height.
1642
 
 
1643
 
This is defined specifically for each OS and query the size of the controlling
1644
 
terminal. If any error occurs, the provided default values should be returned.
1645
 
"""
1646
 
if sys.platform == 'win32':
1647
 
    _terminal_size = _win32_terminal_size
1648
 
else:
1649
 
    _terminal_size = _ioctl_terminal_size
 
1260
    if width <= 0:
 
1261
        try:
 
1262
            width = int(os.environ['COLUMNS'])
 
1263
        except:
 
1264
            pass
 
1265
    if width <= 0:
 
1266
        width = 80
 
1267
 
 
1268
    return width
1650
1269
 
1651
1270
 
1652
1271
def supports_executable():
1777
1396
        dirblock = []
1778
1397
        append = dirblock.append
1779
1398
        try:
1780
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1399
            names = sorted(_listdir(top))
1781
1400
        except OSError, e:
1782
1401
            if not _is_error_enotdir(e):
1783
1402
                raise
1837
1456
    """
1838
1457
    global _selected_dir_reader
1839
1458
    if _selected_dir_reader is None:
 
1459
        fs_encoding = _fs_enc.upper()
1840
1460
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1841
1461
            # Win98 doesn't have unicode apis like FindFirstFileW
1842
1462
            # TODO: We possibly could support Win98 by falling back to the
1848
1468
                _selected_dir_reader = Win32ReadDir()
1849
1469
            except ImportError:
1850
1470
                pass
1851
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1471
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1472
            # ANSI_X3.4-1968 is a form of ASCII
1852
1473
            try:
1853
1474
                from bzrlib._readdir_pyx import UTF8DirReader
1854
1475
                _selected_dir_reader = UTF8DirReader()
1855
 
            except ImportError, e:
1856
 
                failed_to_load_extension(e)
 
1476
            except ImportError:
1857
1477
                pass
1858
1478
 
1859
1479
    if _selected_dir_reader is None:
1970
1590
            real_handlers[kind](abspath, relpath)
1971
1591
 
1972
1592
 
1973
 
def copy_ownership_from_path(dst, src=None):
1974
 
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1975
 
 
1976
 
    If src is None, the containing directory is used as source. If chown
1977
 
    fails, the error is ignored and a warning is printed.
1978
 
    """
1979
 
    chown = getattr(os, 'chown', None)
1980
 
    if chown is None:
1981
 
        return
1982
 
 
1983
 
    if src == None:
1984
 
        src = os.path.dirname(dst)
1985
 
        if src == '':
1986
 
            src = '.'
1987
 
 
1988
 
    try:
1989
 
        s = os.stat(src)
1990
 
        chown(dst, s.st_uid, s.st_gid)
1991
 
    except OSError, e:
1992
 
        trace.warning(
1993
 
            'Unable to copy ownership from "%s" to "%s". '
1994
 
            'You may want to set it manually.', src, dst)
1995
 
        trace.log_exception_quietly()
1996
 
 
1997
 
 
1998
1593
def path_prefix_key(path):
1999
1594
    """Generate a prefix-order path key for path.
2000
1595
 
2013
1608
_cached_user_encoding = None
2014
1609
 
2015
1610
 
2016
 
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
 
1611
def get_user_encoding(use_cache=True):
2017
1612
    """Find out what the preferred user encoding is.
2018
1613
 
2019
1614
    This is generally the encoding that is used for command line parameters
2020
1615
    and file contents. This may be different from the terminal encoding
2021
1616
    or the filesystem encoding.
2022
1617
 
 
1618
    :param  use_cache:  Enable cache for detected encoding.
 
1619
                        (This parameter is turned on by default,
 
1620
                        and required only for selftesting)
 
1621
 
2023
1622
    :return: A string defining the preferred user encoding
2024
1623
    """
2025
1624
    global _cached_user_encoding
2026
 
    if deprecated_passed(use_cache):
2027
 
        warn_deprecated("use_cache should only have been used for tests",
2028
 
            DeprecationWarning, stacklevel=2) 
2029
 
    if _cached_user_encoding is not None:
 
1625
    if _cached_user_encoding is not None and use_cache:
2030
1626
        return _cached_user_encoding
2031
1627
 
2032
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2033
 
        # Use the existing locale settings and call nl_langinfo directly
2034
 
        # rather than going through getpreferredencoding. This avoids
2035
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2036
 
        # possibility of the setlocale call throwing an error.
2037
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1628
    if sys.platform == 'darwin':
 
1629
        # python locale.getpreferredencoding() always return
 
1630
        # 'mac-roman' on darwin. That's a lie.
 
1631
        sys.platform = 'posix'
 
1632
        try:
 
1633
            if os.environ.get('LANG', None) is None:
 
1634
                # If LANG is not set, we end up with 'ascii', which is bad
 
1635
                # ('mac-roman' is more than ascii), so we set a default which
 
1636
                # will give us UTF-8 (which appears to work in all cases on
 
1637
                # OSX). Users are still free to override LANG of course, as
 
1638
                # long as it give us something meaningful. This work-around
 
1639
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1640
                # work with them too -- vila 20080908
 
1641
                os.environ['LANG'] = 'en_US.UTF-8'
 
1642
            import locale
 
1643
        finally:
 
1644
            sys.platform = 'darwin'
2038
1645
    else:
2039
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2040
 
        user_encoding = locale.getpreferredencoding(False)
 
1646
        import locale
2041
1647
 
2042
1648
    try:
2043
 
        user_encoding = codecs.lookup(user_encoding).name
2044
 
    except LookupError:
2045
 
        if user_encoding not in ("", "cp0"):
 
1649
        user_encoding = locale.getpreferredencoding()
 
1650
    except locale.Error, e:
 
1651
        sys.stderr.write('bzr: warning: %s\n'
 
1652
                         '  Could not determine what text encoding to use.\n'
 
1653
                         '  This error usually means your Python interpreter\n'
 
1654
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1655
                         "  Continuing with ascii encoding.\n"
 
1656
                         % (e, os.environ.get('LANG')))
 
1657
        user_encoding = 'ascii'
 
1658
 
 
1659
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1660
    # treat that as ASCII, and not support printing unicode characters to the
 
1661
    # console.
 
1662
    #
 
1663
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1664
    if user_encoding in (None, 'cp0', ''):
 
1665
        user_encoding = 'ascii'
 
1666
    else:
 
1667
        # check encoding
 
1668
        try:
 
1669
            codecs.lookup(user_encoding)
 
1670
        except LookupError:
2046
1671
            sys.stderr.write('bzr: warning:'
2047
1672
                             ' unknown encoding %s.'
2048
1673
                             ' Continuing with ascii encoding.\n'
2049
1674
                             % user_encoding
2050
1675
                            )
2051
 
        user_encoding = 'ascii'
2052
 
    else:
2053
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2054
 
        if user_encoding == 'ascii':
2055
 
            if sys.platform == 'darwin':
2056
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2057
 
                # encoding and previously had LANG set here if not present.
2058
 
                user_encoding = 'utf-8'
2059
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2060
 
            #                for some other posix platforms as well.
2061
 
 
2062
 
    _cached_user_encoding = user_encoding
 
1676
            user_encoding = 'ascii'
 
1677
 
 
1678
    if use_cache:
 
1679
        _cached_user_encoding = user_encoding
 
1680
 
2063
1681
    return user_encoding
2064
1682
 
2065
1683
 
2066
 
def get_diff_header_encoding():
2067
 
    return get_terminal_encoding()
2068
 
 
2069
 
 
2070
1684
def get_host_name():
2071
1685
    """Return the current unicode host name.
2072
1686
 
2074
1688
    behaves inconsistently on different platforms.
2075
1689
    """
2076
1690
    if sys.platform == "win32":
 
1691
        import win32utils
2077
1692
        return win32utils.get_host_name()
2078
1693
    else:
2079
1694
        import socket
2080
1695
        return socket.gethostname().decode(get_user_encoding())
2081
1696
 
2082
1697
 
2083
 
# We must not read/write any more than 64k at a time from/to a socket so we
2084
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
2085
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2086
 
# data at once.
2087
 
MAX_SOCKET_CHUNK = 64 * 1024
2088
 
 
2089
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2090
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2091
 
    _eno = getattr(errno, _eno, None)
2092
 
    if _eno is not None:
2093
 
        _end_of_stream_errors.append(_eno)
2094
 
del _eno
2095
 
 
2096
 
 
2097
 
def read_bytes_from_socket(sock, report_activity=None,
2098
 
        max_read_size=MAX_SOCKET_CHUNK):
2099
 
    """Read up to max_read_size of bytes from sock and notify of progress.
2100
 
 
2101
 
    Translates "Connection reset by peer" into file-like EOF (return an
2102
 
    empty string rather than raise an error), and repeats the recv if
2103
 
    interrupted by a signal.
2104
 
    """
2105
 
    while 1:
2106
 
        try:
2107
 
            bytes = sock.recv(max_read_size)
2108
 
        except socket.error, e:
2109
 
            eno = e.args[0]
2110
 
            if eno in _end_of_stream_errors:
2111
 
                # The connection was closed by the other side.  Callers expect
2112
 
                # an empty string to signal end-of-stream.
2113
 
                return ""
2114
 
            elif eno == errno.EINTR:
2115
 
                # Retry the interrupted recv.
2116
 
                continue
2117
 
            raise
2118
 
        else:
2119
 
            if report_activity is not None:
2120
 
                report_activity(len(bytes), 'read')
2121
 
            return bytes
2122
 
 
2123
 
 
2124
 
def recv_all(socket, count):
 
1698
def recv_all(socket, bytes):
2125
1699
    """Receive an exact number of bytes.
2126
1700
 
2127
1701
    Regular Socket.recv() may return less than the requested number of bytes,
2128
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1702
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2129
1703
    on all platforms, but this should work everywhere.  This will return
2130
1704
    less than the requested amount if the remote end closes.
2131
1705
 
2132
1706
    This isn't optimized and is intended mostly for use in testing.
2133
1707
    """
2134
1708
    b = ''
2135
 
    while len(b) < count:
2136
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1709
    while len(b) < bytes:
 
1710
        new = until_no_eintr(socket.recv, bytes - len(b))
2137
1711
        if new == '':
2138
1712
            break # eof
2139
1713
        b += new
2140
1714
    return b
2141
1715
 
2142
1716
 
2143
 
def send_all(sock, bytes, report_activity=None):
 
1717
def send_all(socket, bytes, report_activity=None):
2144
1718
    """Send all bytes on a socket.
2145
1719
 
2146
 
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2147
 
    some platforms, and catches EINTR which may be thrown if the send is
2148
 
    interrupted by a signal.
2149
 
 
2150
 
    This is preferred to socket.sendall(), because it avoids portability bugs
2151
 
    and provides activity reporting.
 
1720
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1721
    implementation sends no more than 64k at a time, which avoids this problem.
2152
1722
 
2153
1723
    :param report_activity: Call this as bytes are read, see
2154
1724
        Transport._report_activity
2155
1725
    """
2156
 
    sent_total = 0
2157
 
    byte_count = len(bytes)
2158
 
    while sent_total < byte_count:
2159
 
        try:
2160
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2161
 
        except (socket.error, IOError), e:
2162
 
            if e.args[0] in _end_of_stream_errors:
2163
 
                raise errors.ConnectionReset(
2164
 
                    "Error trying to write to socket", e)
2165
 
            if e.args[0] != errno.EINTR:
2166
 
                raise
2167
 
        else:
2168
 
            if sent == 0:
2169
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2170
 
                                             % (sock,))
2171
 
            sent_total += sent
2172
 
            if report_activity is not None:
2173
 
                report_activity(sent, 'write')
2174
 
 
2175
 
 
2176
 
def connect_socket(address):
2177
 
    # Slight variation of the socket.create_connection() function (provided by
2178
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2179
 
    # provide it for previous python versions. Also, we don't use the timeout
2180
 
    # parameter (provided by the python implementation) so we don't implement
2181
 
    # it either).
2182
 
    err = socket.error('getaddrinfo returns an empty list')
2183
 
    host, port = address
2184
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2185
 
        af, socktype, proto, canonname, sa = res
2186
 
        sock = None
2187
 
        try:
2188
 
            sock = socket.socket(af, socktype, proto)
2189
 
            sock.connect(sa)
2190
 
            return sock
2191
 
 
2192
 
        except socket.error, err:
2193
 
            # 'err' is now the most recent error
2194
 
            if sock is not None:
2195
 
                sock.close()
2196
 
    raise err
 
1726
    chunk_size = 2**16
 
1727
    for pos in xrange(0, len(bytes), chunk_size):
 
1728
        block = bytes[pos:pos+chunk_size]
 
1729
        if report_activity is not None:
 
1730
            report_activity(len(block), 'write')
 
1731
        until_no_eintr(socket.sendall, block)
2197
1732
 
2198
1733
 
2199
1734
def dereference_path(path):
2240
1775
    base = dirname(bzrlib.__file__)
2241
1776
    if getattr(sys, 'frozen', None):    # bzr.exe
2242
1777
        base = abspath(pathjoin(base, '..', '..'))
2243
 
    f = file(pathjoin(base, resource_relpath), "rU")
2244
 
    try:
2245
 
        return f.read()
2246
 
    finally:
2247
 
        f.close()
 
1778
    filename = pathjoin(base, resource_relpath)
 
1779
    return open(filename, 'rU').read()
 
1780
 
2248
1781
 
2249
1782
def file_kind_from_stat_mode_thunk(mode):
2250
1783
    global file_kind_from_stat_mode
2252
1785
        try:
2253
1786
            from bzrlib._readdir_pyx import UTF8DirReader
2254
1787
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2255
 
        except ImportError, e:
2256
 
            # This is one time where we won't warn that an extension failed to
2257
 
            # load. The extension is never available on Windows anyway.
 
1788
        except ImportError:
2258
1789
            from bzrlib._readdir_py import (
2259
1790
                _kind_from_mode as file_kind_from_stat_mode
2260
1791
                )
2261
1792
    return file_kind_from_stat_mode(mode)
2262
1793
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2263
1794
 
2264
 
def file_stat(f, _lstat=os.lstat):
 
1795
 
 
1796
def file_kind(f, _lstat=os.lstat):
2265
1797
    try:
2266
 
        # XXX cache?
2267
 
        return _lstat(f)
 
1798
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2268
1799
    except OSError, e:
2269
1800
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2270
1801
            raise errors.NoSuchFile(f)
2271
1802
        raise
2272
1803
 
2273
 
def file_kind(f, _lstat=os.lstat):
2274
 
    stat_value = file_stat(f, _lstat)
2275
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2276
1804
 
2277
1805
def until_no_eintr(f, *a, **kw):
2278
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2279
 
 
2280
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2281
 
    if EINTR does occur.  This is typically only true for low-level operations
2282
 
    like os.read.  If in any doubt, don't use this.
2283
 
 
2284
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2285
 
    probably code in the Python standard library and other dependencies that
2286
 
    may encounter EINTR if a signal arrives (and there is signal handler for
2287
 
    that signal).  So this function can reduce the impact for IO that bzrlib
2288
 
    directly controls, but it is not a complete solution.
2289
 
    """
 
1806
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2290
1807
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2291
1808
    while True:
2292
1809
        try:
2296
1813
                continue
2297
1814
            raise
2298
1815
 
2299
 
 
2300
 
@deprecated_function(deprecated_in((2, 2, 0)))
2301
1816
def re_compile_checked(re_string, flags=0, where=""):
2302
1817
    """Return a compiled re, or raise a sensible error.
2303
1818
 
2313
1828
        re_obj = re.compile(re_string, flags)
2314
1829
        re_obj.search("")
2315
1830
        return re_obj
2316
 
    except errors.InvalidPattern, e:
 
1831
    except re.error, e:
2317
1832
        if where:
2318
1833
            where = ' in ' + where
2319
1834
        # despite the name 'error' is a type
2320
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2321
 
            % (where, e.msg))
 
1835
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1836
            % (where, re_string, e))
2322
1837
 
2323
1838
 
2324
1839
if sys.platform == "win32":
 
1840
    import msvcrt
2325
1841
    def getchar():
2326
 
        import msvcrt
2327
1842
        return msvcrt.getch()
2328
1843
else:
 
1844
    import tty
 
1845
    import termios
2329
1846
    def getchar():
2330
 
        import tty
2331
 
        import termios
2332
1847
        fd = sys.stdin.fileno()
2333
1848
        settings = termios.tcgetattr(fd)
2334
1849
        try:
2338
1853
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2339
1854
        return ch
2340
1855
 
2341
 
if sys.platform.startswith('linux'):
 
1856
 
 
1857
if sys.platform == 'linux2':
2342
1858
    def _local_concurrency():
2343
 
        try:
2344
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2345
 
        except (ValueError, OSError, AttributeError):
2346
 
            return None
 
1859
        concurrency = None
 
1860
        prefix = 'processor'
 
1861
        for line in file('/proc/cpuinfo', 'rb'):
 
1862
            if line.startswith(prefix):
 
1863
                concurrency = int(line[line.find(':')+1:]) + 1
 
1864
        return concurrency
2347
1865
elif sys.platform == 'darwin':
2348
1866
    def _local_concurrency():
2349
1867
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2350
1868
                                stdout=subprocess.PIPE).communicate()[0]
2351
 
elif "bsd" in sys.platform:
 
1869
elif sys.platform[0:7] == 'freebsd':
2352
1870
    def _local_concurrency():
2353
1871
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2354
1872
                                stdout=subprocess.PIPE).communicate()[0]
2375
1893
    anything goes wrong.
2376
1894
    """
2377
1895
    global _cached_local_concurrency
2378
 
 
2379
1896
    if _cached_local_concurrency is not None and use_cache:
2380
1897
        return _cached_local_concurrency
2381
1898
 
2382
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2383
 
    if concurrency is None:
2384
 
        try:
2385
 
            import multiprocessing
2386
 
            concurrency = multiprocessing.cpu_count()
2387
 
        except (ImportError, NotImplementedError):
2388
 
            # multiprocessing is only available on Python >= 2.6
2389
 
            # and multiprocessing.cpu_count() isn't implemented on all
2390
 
            # platforms
2391
 
            try:
2392
 
                concurrency = _local_concurrency()
2393
 
            except (OSError, IOError):
2394
 
                pass
 
1899
    try:
 
1900
        concurrency = _local_concurrency()
 
1901
    except (OSError, IOError):
 
1902
        concurrency = None
2395
1903
    try:
2396
1904
        concurrency = int(concurrency)
2397
1905
    except (TypeError, ValueError):
2399
1907
    if use_cache:
2400
1908
        _cached_concurrency = concurrency
2401
1909
    return concurrency
2402
 
 
2403
 
 
2404
 
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2405
 
    """A stream writer that doesn't decode str arguments."""
2406
 
 
2407
 
    def __init__(self, encode, stream, errors='strict'):
2408
 
        codecs.StreamWriter.__init__(self, stream, errors)
2409
 
        self.encode = encode
2410
 
 
2411
 
    def write(self, object):
2412
 
        if type(object) is str:
2413
 
            self.stream.write(object)
2414
 
        else:
2415
 
            data, _ = self.encode(object, self.errors)
2416
 
            self.stream.write(data)
2417
 
 
2418
 
if sys.platform == 'win32':
2419
 
    def open_file(filename, mode='r', bufsize=-1):
2420
 
        """This function is used to override the ``open`` builtin.
2421
 
 
2422
 
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2423
 
        child processes.  Deleting or renaming a closed file opened with this
2424
 
        function is not blocking child processes.
2425
 
        """
2426
 
        writing = 'w' in mode
2427
 
        appending = 'a' in mode
2428
 
        updating = '+' in mode
2429
 
        binary = 'b' in mode
2430
 
 
2431
 
        flags = O_NOINHERIT
2432
 
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2433
 
        # for flags for each modes.
2434
 
        if binary:
2435
 
            flags |= O_BINARY
2436
 
        else:
2437
 
            flags |= O_TEXT
2438
 
 
2439
 
        if writing:
2440
 
            if updating:
2441
 
                flags |= os.O_RDWR
2442
 
            else:
2443
 
                flags |= os.O_WRONLY
2444
 
            flags |= os.O_CREAT | os.O_TRUNC
2445
 
        elif appending:
2446
 
            if updating:
2447
 
                flags |= os.O_RDWR
2448
 
            else:
2449
 
                flags |= os.O_WRONLY
2450
 
            flags |= os.O_CREAT | os.O_APPEND
2451
 
        else: #reading
2452
 
            if updating:
2453
 
                flags |= os.O_RDWR
2454
 
            else:
2455
 
                flags |= os.O_RDONLY
2456
 
 
2457
 
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2458
 
else:
2459
 
    open_file = open
2460
 
 
2461
 
 
2462
 
def available_backup_name(base, exists):
2463
 
    """Find a non-existing backup file name.
2464
 
 
2465
 
    This will *not* create anything, this only return a 'free' entry.  This
2466
 
    should be used for checking names in a directory below a locked
2467
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2468
 
    Leap) and generally discouraged.
2469
 
 
2470
 
    :param base: The base name.
2471
 
 
2472
 
    :param exists: A callable returning True if the path parameter exists.
2473
 
    """
2474
 
    counter = 1
2475
 
    name = "%s.~%d~" % (base, counter)
2476
 
    while exists(name):
2477
 
        counter += 1
2478
 
        name = "%s.~%d~" % (base, counter)
2479
 
    return name
2480
 
 
2481
 
 
2482
 
def set_fd_cloexec(fd):
2483
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2484
 
    support for this is not available.
2485
 
    """
2486
 
    try:
2487
 
        import fcntl
2488
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2489
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2490
 
    except (ImportError, AttributeError):
2491
 
        # Either the fcntl module or specific constants are not present
2492
 
        pass
2493
 
 
2494
 
 
2495
 
def find_executable_on_path(name):
2496
 
    """Finds an executable on the PATH.
2497
 
    
2498
 
    On Windows, this will try to append each extension in the PATHEXT
2499
 
    environment variable to the name, if it cannot be found with the name
2500
 
    as given.
2501
 
    
2502
 
    :param name: The base name of the executable.
2503
 
    :return: The path to the executable found or None.
2504
 
    """
2505
 
    if sys.platform == 'win32':
2506
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2507
 
        exts = [ext.lower() for ext in exts]
2508
 
        base, ext = os.path.splitext(name)
2509
 
        if ext != '':
2510
 
            if ext.lower() not in exts:
2511
 
                return None
2512
 
            name = base
2513
 
            exts = [ext]
2514
 
    else:
2515
 
        exts = ['']
2516
 
    path = os.environ.get('PATH')
2517
 
    if path is not None:
2518
 
        path = path.split(os.pathsep)
2519
 
        for ext in exts:
2520
 
            for d in path:
2521
 
                f = os.path.join(d, name) + ext
2522
 
                if os.access(f, os.X_OK):
2523
 
                    return f
2524
 
    if sys.platform == 'win32':
2525
 
        app_path = win32utils.get_app_path(name)
2526
 
        if app_path != name:
2527
 
            return app_path
2528
 
    return None
2529
 
 
2530
 
 
2531
 
def _posix_is_local_pid_dead(pid):
2532
 
    """True if pid doesn't correspond to live process on this machine"""
2533
 
    try:
2534
 
        # Special meaning of unix kill: just check if it's there.
2535
 
        os.kill(pid, 0)
2536
 
    except OSError, e:
2537
 
        if e.errno == errno.ESRCH:
2538
 
            # On this machine, and really not found: as sure as we can be
2539
 
            # that it's dead.
2540
 
            return True
2541
 
        elif e.errno == errno.EPERM:
2542
 
            # exists, though not ours
2543
 
            return False
2544
 
        else:
2545
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2546
 
            # Don't really know.
2547
 
            return False
2548
 
    else:
2549
 
        # Exists and our process: not dead.
2550
 
        return False
2551
 
 
2552
 
if sys.platform == "win32":
2553
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2554
 
else:
2555
 
    is_local_pid_dead = _posix_is_local_pid_dead
2556
 
 
2557
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2558
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2559
 
                      if getattr(errno, name, None) is not None]
2560
 
 
2561
 
 
2562
 
def fdatasync(fileno):
2563
 
    """Flush file contents to disk if possible.
2564
 
    
2565
 
    :param fileno: Integer OS file handle.
2566
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2567
 
    """
2568
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2569
 
    if fn is not None:
2570
 
        try:
2571
 
            fn(fileno)
2572
 
        except IOError, e:
2573
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2574
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2575
 
            # and reduce the chance of corruption-on-powerloss situations. It
2576
 
            # is not a mandatory call, so it is ok to suppress failures.
2577
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2578
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2579
 
                raise
2580
 
 
2581
 
 
2582
 
def ensure_empty_directory_exists(path, exception_class):
2583
 
    """Make sure a local directory exists and is empty.
2584
 
    
2585
 
    If it does not exist, it is created.  If it exists and is not empty, an
2586
 
    instance of exception_class is raised.
2587
 
    """
2588
 
    try:
2589
 
        os.mkdir(path)
2590
 
    except OSError, e:
2591
 
        if e.errno != errno.EEXIST:
2592
 
            raise
2593
 
        if os.listdir(path) != []:
2594
 
            raise exception_class(path)
2595
 
 
2596
 
 
2597
 
def is_environment_error(evalue):
2598
 
    """True if exception instance is due to a process environment issue
2599
 
 
2600
 
    This includes OSError and IOError, but also other errors that come from
2601
 
    the operating system or core libraries but are not subclasses of those.
2602
 
    """
2603
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2604
 
        return True
2605
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2606
 
        return True
2607
 
    return False