~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
import errno
18
17
import os
19
18
import re
20
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)
21
22
import sys
22
23
import time
23
 
import codecs
24
24
 
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
 
27
import codecs
27
28
from datetime import datetime
28
 
import getpass
29
 
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
                    )
30
36
import posixpath
31
 
# We need to import both shutil and rmtree as we export the later on posix
32
 
# and need the former on windows
33
37
import shutil
34
 
from shutil import rmtree
35
 
import socket
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
36
41
import subprocess
37
 
# We need to import both tempfile and mkdtemp as we export the later on posix
38
 
# and need the former on windows
39
42
import tempfile
40
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
41
46
import unicodedata
42
47
 
43
48
from bzrlib import (
44
49
    cache_utf8,
45
50
    errors,
46
 
    trace,
47
51
    win32utils,
48
52
    )
49
53
""")
50
54
 
51
 
from bzrlib.symbol_versioning import (
52
 
    deprecated_function,
53
 
    deprecated_in,
54
 
    )
55
 
 
56
55
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
57
56
# of 2.5
58
57
if sys.version_info < (2, 5):
71
70
from bzrlib import symbol_versioning
72
71
 
73
72
 
74
 
# Cross platform wall-clock time functionality with decent resolution.
75
 
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
76
 
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
77
 
# synchronized with ``time.time()``, this is only meant to be used to find
78
 
# delta times by subtracting from another call to this function.
79
 
timer_func = time.time
80
 
if sys.platform == 'win32':
81
 
    timer_func = time.clock
82
 
 
83
73
# On win32, O_BINARY is used to indicate the file should
84
74
# be opened in binary mode, rather than text mode.
85
75
# On other platforms, O_BINARY doesn't exist, because
181
171
    try:
182
172
        return _kind_marker_map[kind]
183
173
    except KeyError:
184
 
        # Slightly faster than using .get(, '') when the common case is that
185
 
        # kind will be found
186
 
        return ''
 
174
        raise errors.BzrError('invalid file kind %r' % kind)
187
175
 
188
176
 
189
177
lexists = getattr(os.path, 'lexists', None)
206
194
    :param old: The old path, to rename from
207
195
    :param new: The new path, to rename to
208
196
    :param rename_func: The potentially non-atomic rename function
209
 
    :param unlink_func: A way to delete the target file if the full rename
210
 
        succeeds
 
197
    :param unlink_func: A way to delete the target file if the full rename succeeds
211
198
    """
 
199
 
212
200
    # sftp rename doesn't allow overwriting, so play tricks:
213
201
    base = os.path.basename(new)
214
202
    dirname = os.path.dirname(new)
215
 
    # callers use different encodings for the paths so the following MUST
216
 
    # respect that. We rely on python upcasting to unicode if new is unicode
217
 
    # and keeping a str if not.
218
 
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
219
 
                                      os.getpid(), rand_chars(10))
 
203
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
220
204
    tmp_name = pathjoin(dirname, tmp_name)
221
205
 
222
206
    # Rename the file out of the way, but keep track if it didn't exist
242
226
    else:
243
227
        file_existed = True
244
228
 
245
 
    failure_exc = None
246
229
    success = False
247
230
    try:
248
231
        try:
254
237
            # source and target may be aliases of each other (e.g. on a
255
238
            # case-insensitive filesystem), so we may have accidentally renamed
256
239
            # source by when we tried to rename target
257
 
            failure_exc = sys.exc_info()
258
 
            if (file_existed and e.errno in (None, errno.ENOENT)
259
 
                and old.lower() == new.lower()):
260
 
                # source and target are the same file on a case-insensitive
261
 
                # filesystem, so we don't generate an exception
262
 
                failure_exc = None
 
240
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
241
                raise
263
242
    finally:
264
243
        if file_existed:
265
244
            # If the file used to exist, rename it back into place
268
247
                unlink_func(tmp_name)
269
248
            else:
270
249
                rename_func(tmp_name, new)
271
 
    if failure_exc is not None:
272
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
273
250
 
274
251
 
275
252
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
298
275
    running python.exe under cmd.exe return capital C:\\
299
276
    running win32 python inside a cygwin shell returns lowercase c:\\
300
277
    """
301
 
    drive, path = ntpath.splitdrive(path)
 
278
    drive, path = _nt_splitdrive(path)
302
279
    return drive.upper() + path
303
280
 
304
281
 
305
282
def _win32_abspath(path):
306
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
307
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
283
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
284
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
308
285
 
309
286
 
310
287
def _win98_abspath(path):
321
298
    #   /path       => C:/path
322
299
    path = unicode(path)
323
300
    # check for absolute path
324
 
    drive = ntpath.splitdrive(path)[0]
 
301
    drive = _nt_splitdrive(path)[0]
325
302
    if drive == '' and path[:2] not in('//','\\\\'):
326
303
        cwd = os.getcwdu()
327
304
        # we cannot simply os.path.join cwd and path
328
305
        # because os.path.join('C:','/path') produce '/path'
329
306
        # and this is incorrect
330
307
        if path[:1] in ('/','\\'):
331
 
            cwd = ntpath.splitdrive(cwd)[0]
 
308
            cwd = _nt_splitdrive(cwd)[0]
332
309
            path = path[1:]
333
310
        path = cwd + '\\' + path
334
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
311
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
335
312
 
336
313
 
337
314
def _win32_realpath(path):
338
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
339
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
315
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
316
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
340
317
 
341
318
 
342
319
def _win32_pathjoin(*args):
343
 
    return ntpath.join(*args).replace('\\', '/')
 
320
    return _nt_join(*args).replace('\\', '/')
344
321
 
345
322
 
346
323
def _win32_normpath(path):
347
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
324
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
348
325
 
349
326
 
350
327
def _win32_getcwd():
389
366
basename = os.path.basename
390
367
split = os.path.split
391
368
splitext = os.path.splitext
392
 
# These were already lazily imported into local scope
 
369
# These were already imported into local scope
393
370
# mkdtemp = tempfile.mkdtemp
394
371
# rmtree = shutil.rmtree
395
372
 
435
412
    getcwd = _mac_getcwd
436
413
 
437
414
 
438
 
def get_terminal_encoding(trace=False):
 
415
def get_terminal_encoding():
439
416
    """Find the best encoding for printing to the screen.
440
417
 
441
418
    This attempts to check both sys.stdout and sys.stdin to see
447
424
 
448
425
    On my standard US Windows XP, the preferred encoding is
449
426
    cp1252, but the console is cp437
450
 
 
451
 
    :param trace: If True trace the selected encoding via mutter().
452
427
    """
453
428
    from bzrlib.trace import mutter
454
429
    output_encoding = getattr(sys.stdout, 'encoding', None)
456
431
        input_encoding = getattr(sys.stdin, 'encoding', None)
457
432
        if not input_encoding:
458
433
            output_encoding = get_user_encoding()
459
 
            if trace:
460
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
434
            mutter('encoding stdout as osutils.get_user_encoding() %r',
461
435
                   output_encoding)
462
436
        else:
463
437
            output_encoding = input_encoding
464
 
            if trace:
465
 
                mutter('encoding stdout as sys.stdin encoding %r',
466
 
                    output_encoding)
 
438
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
467
439
    else:
468
 
        if trace:
469
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
440
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
441
    if output_encoding == 'cp0':
471
442
        # invalid encoding (cp0 means 'no codepage' on Windows)
472
443
        output_encoding = get_user_encoding()
473
 
        if trace:
474
 
            mutter('cp0 is invalid encoding.'
 
444
        mutter('cp0 is invalid encoding.'
475
445
               ' encoding stdout as osutils.get_user_encoding() %r',
476
446
               output_encoding)
477
447
    # check encoding
503
473
def isdir(f):
504
474
    """True if f is an accessible directory."""
505
475
    try:
506
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
476
        return S_ISDIR(os.lstat(f)[ST_MODE])
507
477
    except OSError:
508
478
        return False
509
479
 
511
481
def isfile(f):
512
482
    """True if f is a regular file."""
513
483
    try:
514
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
484
        return S_ISREG(os.lstat(f)[ST_MODE])
515
485
    except OSError:
516
486
        return False
517
487
 
518
488
def islink(f):
519
489
    """True if f is a symlink."""
520
490
    try:
521
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
491
        return S_ISLNK(os.lstat(f)[ST_MODE])
522
492
    except OSError:
523
493
        return False
524
494
 
720
690
    return offset.days * 86400 + offset.seconds
721
691
 
722
692
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
723
 
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
724
 
 
725
693
 
726
694
def format_date(t, offset=0, timezone='original', date_fmt=None,
727
695
                show_offset=True):
741
709
    date_str = time.strftime(date_fmt, tt)
742
710
    return date_str + offset_str
743
711
 
744
 
 
745
 
# Cache of formatted offset strings
746
 
_offset_cache = {}
747
 
 
748
 
 
749
 
def format_date_with_offset_in_original_timezone(t, offset=0,
750
 
    _cache=_offset_cache):
751
 
    """Return a formatted date string in the original timezone.
752
 
 
753
 
    This routine may be faster then format_date.
754
 
 
755
 
    :param t: Seconds since the epoch.
756
 
    :param offset: Timezone offset in seconds east of utc.
757
 
    """
758
 
    if offset is None:
759
 
        offset = 0
760
 
    tt = time.gmtime(t + offset)
761
 
    date_fmt = _default_format_by_weekday_num[tt[6]]
762
 
    date_str = time.strftime(date_fmt, tt)
763
 
    offset_str = _cache.get(offset, None)
764
 
    if offset_str is None:
765
 
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
766
 
        _cache[offset] = offset_str
767
 
    return date_str + offset_str
768
 
 
769
 
 
770
712
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
771
713
                      show_offset=True):
772
714
    """Return an unicode date string formatted according to the current locale.
786
728
        date_str = date_str.decode(get_user_encoding(), 'replace')
787
729
    return date_str + offset_str
788
730
 
789
 
 
790
731
def _format_date(t, offset, timezone, date_fmt, show_offset):
791
732
    if timezone == 'utc':
792
733
        tt = time.gmtime(t)
864
805
 
865
806
def filesize(f):
866
807
    """Return size of given open file."""
867
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
808
    return os.fstat(f.fileno())[ST_SIZE]
868
809
 
869
810
 
870
811
# Define rand_bytes based on platform.
932
873
 
933
874
def parent_directories(filename):
934
875
    """Return the list of parent directories, deepest first.
935
 
 
 
876
    
936
877
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
937
878
    """
938
879
    parents = []
943
884
    return parents
944
885
 
945
886
 
946
 
_extension_load_failures = []
947
 
 
948
 
 
949
 
def failed_to_load_extension(exception):
950
 
    """Handle failing to load a binary extension.
951
 
 
952
 
    This should be called from the ImportError block guarding the attempt to
953
 
    import the native extension.  If this function returns, the pure-Python
954
 
    implementation should be loaded instead::
955
 
 
956
 
    >>> try:
957
 
    >>>     import bzrlib._fictional_extension_pyx
958
 
    >>> except ImportError, e:
959
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
960
 
    >>>     import bzrlib._fictional_extension_py
961
 
    """
962
 
    # NB: This docstring is just an example, not a doctest, because doctest
963
 
    # currently can't cope with the use of lazy imports in this namespace --
964
 
    # mbp 20090729
965
 
 
966
 
    # This currently doesn't report the failure at the time it occurs, because
967
 
    # they tend to happen very early in startup when we can't check config
968
 
    # files etc, and also we want to report all failures but not spam the user
969
 
    # with 10 warnings.
970
 
    from bzrlib import trace
971
 
    exception_str = str(exception)
972
 
    if exception_str not in _extension_load_failures:
973
 
        trace.mutter("failed to load compiled extension: %s" % exception_str)
974
 
        _extension_load_failures.append(exception_str)
975
 
 
976
 
 
977
 
def report_extension_load_failures():
978
 
    if not _extension_load_failures:
979
 
        return
980
 
    from bzrlib.config import GlobalConfig
981
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
982
 
        return
983
 
    # the warnings framework should by default show this only once
984
 
    from bzrlib.trace import warning
985
 
    warning(
986
 
        "bzr: warning: some compiled extensions could not be loaded; "
987
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
988
 
    # we no longer show the specific missing extensions here, because it makes
989
 
    # the message too long and scary - see
990
 
    # https://bugs.launchpad.net/bzr/+bug/430529
991
 
 
992
 
 
993
887
try:
994
888
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
995
 
except ImportError, e:
996
 
    failed_to_load_extension(e)
 
889
except ImportError:
997
890
    from bzrlib._chunks_to_lines_py import chunks_to_lines
998
891
 
999
892
 
1038
931
 
1039
932
 
1040
933
def delete_any(path):
1041
 
    """Delete a file, symlink or directory.
1042
 
 
 
934
    """Delete a file, symlink or directory.  
 
935
    
1043
936
    Will delete even if readonly.
1044
937
    """
1045
938
    try:
1131
1024
 
1132
1025
 
1133
1026
def relpath(base, path):
1134
 
    """Return path relative to base, or raise PathNotChild exception.
 
1027
    """Return path relative to base, or raise exception.
1135
1028
 
1136
1029
    The path may be either an absolute path or a path relative to the
1137
1030
    current working directory.
1139
1032
    os.path.commonprefix (python2.4) has a bad bug that it works just
1140
1033
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1141
1034
    avoids that problem.
1142
 
 
1143
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1144
 
    PathNotChild exceptions regardless of `path`.
1145
1035
    """
1146
1036
 
1147
1037
    if len(base) < MIN_ABS_PATHLENGTH:
1234
1124
    # but for now, we haven't optimized...
1235
1125
    return [canonical_relpath(base, p) for p in paths]
1236
1126
 
1237
 
 
1238
 
def decode_filename(filename):
1239
 
    """Decode the filename using the filesystem encoding
1240
 
 
1241
 
    If it is unicode, it is returned.
1242
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1243
 
    fails, a errors.BadFilenameEncoding exception is raised.
1244
 
    """
1245
 
    if type(filename) is unicode:
1246
 
        return filename
1247
 
    try:
1248
 
        return filename.decode(_fs_enc)
1249
 
    except UnicodeDecodeError:
1250
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1251
 
 
1252
 
 
1253
1127
def safe_unicode(unicode_or_utf8_string):
1254
1128
    """Coerce unicode_or_utf8_string into unicode.
1255
1129
 
1338
1212
def normalizes_filenames():
1339
1213
    """Return True if this platform normalizes unicode filenames.
1340
1214
 
1341
 
    Only Mac OSX.
 
1215
    Mac OSX does, Windows/Linux do not.
1342
1216
    """
1343
1217
    return _platform_normalizes_filenames
1344
1218
 
1349
1223
    On platforms where the system normalizes filenames (Mac OSX),
1350
1224
    you can access a file by any path which will normalize correctly.
1351
1225
    On platforms where the system does not normalize filenames
1352
 
    (everything else), you have to access a file by its exact path.
 
1226
    (Windows, Linux), you have to access a file by its exact path.
1353
1227
 
1354
1228
    Internally, bzr only supports NFC normalization, since that is
1355
1229
    the standard for XML documents.
1374
1248
    normalized_filename = _inaccessible_normalized_filename
1375
1249
 
1376
1250
 
1377
 
def set_signal_handler(signum, handler, restart_syscall=True):
1378
 
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
1379
 
    on platforms that support that.
1380
 
 
1381
 
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
1382
 
        automatically restart (by calling `signal.siginterrupt(signum,
1383
 
        False)`).  May be ignored if the feature is not available on this
1384
 
        platform or Python version.
1385
 
    """
1386
 
    try:
1387
 
        import signal
1388
 
        siginterrupt = signal.siginterrupt
1389
 
    except ImportError:
1390
 
        # This python implementation doesn't provide signal support, hence no
1391
 
        # handler exists
1392
 
        return None
1393
 
    except AttributeError:
1394
 
        # siginterrupt doesn't exist on this platform, or for this version
1395
 
        # of Python.
1396
 
        siginterrupt = lambda signum, flag: None
1397
 
    if restart_syscall:
1398
 
        def sig_handler(*args):
1399
 
            # Python resets the siginterrupt flag when a signal is
1400
 
            # received.  <http://bugs.python.org/issue8354>
1401
 
            # As a workaround for some cases, set it back the way we want it.
1402
 
            siginterrupt(signum, False)
1403
 
            # Now run the handler function passed to set_signal_handler.
1404
 
            handler(*args)
1405
 
    else:
1406
 
        sig_handler = handler
1407
 
    old_handler = signal.signal(signum, sig_handler)
1408
 
    if restart_syscall:
1409
 
        siginterrupt(signum, False)
1410
 
    return old_handler
1411
 
 
1412
 
 
1413
 
default_terminal_width = 80
1414
 
"""The default terminal width for ttys.
1415
 
 
1416
 
This is defined so that higher levels can share a common fallback value when
1417
 
terminal_width() returns None.
1418
 
"""
1419
 
 
1420
 
# Keep some state so that terminal_width can detect if _terminal_size has
1421
 
# returned a different size since the process started.  See docstring and
1422
 
# comments of terminal_width for details.
1423
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1424
 
_terminal_size_state = 'no_data'
1425
 
_first_terminal_size = None
1426
 
 
1427
1251
def terminal_width():
1428
 
    """Return terminal width.
1429
 
 
1430
 
    None is returned if the width can't established precisely.
1431
 
 
1432
 
    The rules are:
1433
 
    - if BZR_COLUMNS is set, returns its value
1434
 
    - if there is no controlling terminal, returns None
1435
 
    - query the OS, if the queried size has changed since the last query,
1436
 
      return its value,
1437
 
    - if COLUMNS is set, returns its value,
1438
 
    - if the OS has a value (even though it's never changed), return its value.
1439
 
 
1440
 
    From there, we need to query the OS to get the size of the controlling
1441
 
    terminal.
1442
 
 
1443
 
    On Unices we query the OS by:
1444
 
    - get termios.TIOCGWINSZ
1445
 
    - if an error occurs or a negative value is obtained, returns None
1446
 
 
1447
 
    On Windows we query the OS by:
1448
 
    - win32utils.get_console_size() decides,
1449
 
    - returns None on error (provided default value)
1450
 
    """
1451
 
    # Note to implementors: if changing the rules for determining the width,
1452
 
    # make sure you've considered the behaviour in these cases:
1453
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1454
 
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1455
 
    #    0,0.
1456
 
    #  - (add more interesting cases here, if you find any)
1457
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1458
 
    # but we don't want to register a signal handler because it is impossible
1459
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1460
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1461
 
    # time so we can notice if the reported size has changed, which should have
1462
 
    # a similar effect.
1463
 
 
1464
 
    # If BZR_COLUMNS is set, take it, user is always right
1465
 
    try:
1466
 
        return int(os.environ['BZR_COLUMNS'])
1467
 
    except (KeyError, ValueError):
1468
 
        pass
1469
 
 
1470
 
    isatty = getattr(sys.stdout, 'isatty', None)
1471
 
    if isatty is None or not isatty():
1472
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1473
 
        return None
1474
 
 
1475
 
    # Query the OS
1476
 
    width, height = os_size = _terminal_size(None, None)
1477
 
    global _first_terminal_size, _terminal_size_state
1478
 
    if _terminal_size_state == 'no_data':
1479
 
        _first_terminal_size = os_size
1480
 
        _terminal_size_state = 'unchanged'
1481
 
    elif (_terminal_size_state == 'unchanged' and
1482
 
          _first_terminal_size != os_size):
1483
 
        _terminal_size_state = 'changed'
1484
 
 
1485
 
    # If the OS claims to know how wide the terminal is, and this value has
1486
 
    # ever changed, use that.
1487
 
    if _terminal_size_state == 'changed':
1488
 
        if width is not None and width > 0:
1489
 
            return width
1490
 
 
1491
 
    # If COLUMNS is set, use it.
1492
 
    try:
1493
 
        return int(os.environ['COLUMNS'])
1494
 
    except (KeyError, ValueError):
1495
 
        pass
1496
 
 
1497
 
    # Finally, use an unchanged size from the OS, if we have one.
1498
 
    if _terminal_size_state == 'unchanged':
1499
 
        if width is not None and width > 0:
1500
 
            return width
1501
 
 
1502
 
    # The width could not be determined.
1503
 
    return None
1504
 
 
1505
 
 
1506
 
def _win32_terminal_size(width, height):
1507
 
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1508
 
    return width, height
1509
 
 
1510
 
 
1511
 
def _ioctl_terminal_size(width, height):
 
1252
    """Return estimated terminal width."""
 
1253
    if sys.platform == 'win32':
 
1254
        return win32utils.get_console_size()[0]
 
1255
    width = 0
1512
1256
    try:
1513
1257
        import struct, fcntl, termios
1514
1258
        s = struct.pack('HHHH', 0, 0, 0, 0)
1515
1259
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1516
 
        height, width = struct.unpack('HHHH', x)[0:2]
1517
 
    except (IOError, AttributeError):
 
1260
        width = struct.unpack('HHHH', x)[1]
 
1261
    except IOError:
1518
1262
        pass
1519
 
    return width, height
1520
 
 
1521
 
_terminal_size = None
1522
 
"""Returns the terminal size as (width, height).
1523
 
 
1524
 
:param width: Default value for width.
1525
 
:param height: Default value for height.
1526
 
 
1527
 
This is defined specifically for each OS and query the size of the controlling
1528
 
terminal. If any error occurs, the provided default values should be returned.
1529
 
"""
1530
 
if sys.platform == 'win32':
1531
 
    _terminal_size = _win32_terminal_size
1532
 
else:
1533
 
    _terminal_size = _ioctl_terminal_size
 
1263
    if width <= 0:
 
1264
        try:
 
1265
            width = int(os.environ['COLUMNS'])
 
1266
        except:
 
1267
            pass
 
1268
    if width <= 0:
 
1269
        width = 80
 
1270
 
 
1271
    return width
1534
1272
 
1535
1273
 
1536
1274
def supports_executable():
1661
1399
        dirblock = []
1662
1400
        append = dirblock.append
1663
1401
        try:
1664
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1402
            names = sorted(_listdir(top))
1665
1403
        except OSError, e:
1666
1404
            if not _is_error_enotdir(e):
1667
1405
                raise
1738
1476
            try:
1739
1477
                from bzrlib._readdir_pyx import UTF8DirReader
1740
1478
                _selected_dir_reader = UTF8DirReader()
1741
 
            except ImportError, e:
1742
 
                failed_to_load_extension(e)
 
1479
            except ImportError:
1743
1480
                pass
1744
1481
 
1745
1482
    if _selected_dir_reader is None:
1856
1593
            real_handlers[kind](abspath, relpath)
1857
1594
 
1858
1595
 
1859
 
def copy_ownership_from_path(dst, src=None):
1860
 
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1861
 
 
1862
 
    If src is None, the containing directory is used as source. If chown
1863
 
    fails, the error is ignored and a warning is printed.
1864
 
    """
1865
 
    chown = getattr(os, 'chown', None)
1866
 
    if chown is None:
1867
 
        return
1868
 
 
1869
 
    if src == None:
1870
 
        src = os.path.dirname(dst)
1871
 
        if src == '':
1872
 
            src = '.'
1873
 
 
1874
 
    try:
1875
 
        s = os.stat(src)
1876
 
        chown(dst, s.st_uid, s.st_gid)
1877
 
    except OSError, e:
1878
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1879
 
 
1880
 
 
1881
1596
def path_prefix_key(path):
1882
1597
    """Generate a prefix-order path key for path.
1883
1598
 
1969
1684
    return user_encoding
1970
1685
 
1971
1686
 
1972
 
def get_diff_header_encoding():
1973
 
    return get_terminal_encoding()
1974
 
 
1975
 
 
1976
1687
def get_host_name():
1977
1688
    """Return the current unicode host name.
1978
1689
 
1987
1698
        return socket.gethostname().decode(get_user_encoding())
1988
1699
 
1989
1700
 
1990
 
# We must not read/write any more than 64k at a time from/to a socket so we
1991
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
1992
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1993
 
# data at once.
1994
 
MAX_SOCKET_CHUNK = 64 * 1024
1995
 
 
1996
 
def read_bytes_from_socket(sock, report_activity=None,
1997
 
        max_read_size=MAX_SOCKET_CHUNK):
1998
 
    """Read up to max_read_size of bytes from sock and notify of progress.
1999
 
 
2000
 
    Translates "Connection reset by peer" into file-like EOF (return an
2001
 
    empty string rather than raise an error), and repeats the recv if
2002
 
    interrupted by a signal.
2003
 
    """
2004
 
    while 1:
2005
 
        try:
2006
 
            bytes = sock.recv(max_read_size)
2007
 
        except socket.error, e:
2008
 
            eno = e.args[0]
2009
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2010
 
                # The connection was closed by the other side.  Callers expect
2011
 
                # an empty string to signal end-of-stream.
2012
 
                return ""
2013
 
            elif eno == errno.EINTR:
2014
 
                # Retry the interrupted recv.
2015
 
                continue
2016
 
            raise
2017
 
        else:
2018
 
            if report_activity is not None:
2019
 
                report_activity(len(bytes), 'read')
2020
 
            return bytes
2021
 
 
2022
 
 
2023
 
def recv_all(socket, count):
 
1701
def recv_all(socket, bytes):
2024
1702
    """Receive an exact number of bytes.
2025
1703
 
2026
1704
    Regular Socket.recv() may return less than the requested number of bytes,
2027
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1705
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2028
1706
    on all platforms, but this should work everywhere.  This will return
2029
1707
    less than the requested amount if the remote end closes.
2030
1708
 
2031
1709
    This isn't optimized and is intended mostly for use in testing.
2032
1710
    """
2033
1711
    b = ''
2034
 
    while len(b) < count:
2035
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1712
    while len(b) < bytes:
 
1713
        new = until_no_eintr(socket.recv, bytes - len(b))
2036
1714
        if new == '':
2037
1715
            break # eof
2038
1716
        b += new
2039
1717
    return b
2040
1718
 
2041
1719
 
2042
 
def send_all(sock, bytes, report_activity=None):
 
1720
def send_all(socket, bytes, report_activity=None):
2043
1721
    """Send all bytes on a socket.
2044
1722
 
2045
 
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2046
 
    some platforms, and catches EINTR which may be thrown if the send is
2047
 
    interrupted by a signal.
2048
 
 
2049
 
    This is preferred to socket.sendall(), because it avoids portability bugs
2050
 
    and provides activity reporting.
 
1723
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1724
    implementation sends no more than 64k at a time, which avoids this problem.
2051
1725
 
2052
1726
    :param report_activity: Call this as bytes are read, see
2053
1727
        Transport._report_activity
2054
1728
    """
2055
 
    sent_total = 0
2056
 
    byte_count = len(bytes)
2057
 
    while sent_total < byte_count:
2058
 
        try:
2059
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2060
 
        except socket.error, e:
2061
 
            if e.args[0] != errno.EINTR:
2062
 
                raise
2063
 
        else:
2064
 
            sent_total += sent
2065
 
            report_activity(sent, 'write')
2066
 
 
2067
 
 
2068
 
def connect_socket(address):
2069
 
    # Slight variation of the socket.create_connection() function (provided by
2070
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2071
 
    # provide it for previous python versions. Also, we don't use the timeout
2072
 
    # parameter (provided by the python implementation) so we don't implement
2073
 
    # it either).
2074
 
    err = socket.error('getaddrinfo returns an empty list')
2075
 
    host, port = address
2076
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2077
 
        af, socktype, proto, canonname, sa = res
2078
 
        sock = None
2079
 
        try:
2080
 
            sock = socket.socket(af, socktype, proto)
2081
 
            sock.connect(sa)
2082
 
            return sock
2083
 
 
2084
 
        except socket.error, err:
2085
 
            # 'err' is now the most recent error
2086
 
            if sock is not None:
2087
 
                sock.close()
2088
 
    raise err
 
1729
    chunk_size = 2**16
 
1730
    for pos in xrange(0, len(bytes), chunk_size):
 
1731
        block = bytes[pos:pos+chunk_size]
 
1732
        if report_activity is not None:
 
1733
            report_activity(len(block), 'write')
 
1734
        until_no_eintr(socket.sendall, block)
2089
1735
 
2090
1736
 
2091
1737
def dereference_path(path):
2132
1778
    base = dirname(bzrlib.__file__)
2133
1779
    if getattr(sys, 'frozen', None):    # bzr.exe
2134
1780
        base = abspath(pathjoin(base, '..', '..'))
2135
 
    f = file(pathjoin(base, resource_relpath), "rU")
2136
 
    try:
2137
 
        return f.read()
2138
 
    finally:
2139
 
        f.close()
 
1781
    filename = pathjoin(base, resource_relpath)
 
1782
    return open(filename, 'rU').read()
 
1783
 
2140
1784
 
2141
1785
def file_kind_from_stat_mode_thunk(mode):
2142
1786
    global file_kind_from_stat_mode
2144
1788
        try:
2145
1789
            from bzrlib._readdir_pyx import UTF8DirReader
2146
1790
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2147
 
        except ImportError, e:
2148
 
            # This is one time where we won't warn that an extension failed to
2149
 
            # load. The extension is never available on Windows anyway.
 
1791
        except ImportError:
2150
1792
            from bzrlib._readdir_py import (
2151
1793
                _kind_from_mode as file_kind_from_stat_mode
2152
1794
                )
2164
1806
 
2165
1807
 
2166
1808
def until_no_eintr(f, *a, **kw):
2167
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2168
 
 
2169
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2170
 
    if EINTR does occur.  This is typically only true for low-level operations
2171
 
    like os.read.  If in any doubt, don't use this.
2172
 
 
2173
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2174
 
    probably code in the Python standard library and other dependencies that
2175
 
    may encounter EINTR if a signal arrives (and there is signal handler for
2176
 
    that signal).  So this function can reduce the impact for IO that bzrlib
2177
 
    directly controls, but it is not a complete solution.
2178
 
    """
 
1809
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2179
1810
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2180
1811
    while True:
2181
1812
        try:
2185
1816
                continue
2186
1817
            raise
2187
1818
 
2188
 
 
2189
 
@deprecated_function(deprecated_in((2, 2, 0)))
2190
1819
def re_compile_checked(re_string, flags=0, where=""):
2191
1820
    """Return a compiled re, or raise a sensible error.
2192
1821
 
2202
1831
        re_obj = re.compile(re_string, flags)
2203
1832
        re_obj.search("")
2204
1833
        return re_obj
2205
 
    except errors.InvalidPattern, e:
 
1834
    except re.error, e:
2206
1835
        if where:
2207
1836
            where = ' in ' + where
2208
1837
        # despite the name 'error' is a type
2209
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2210
 
            % (where, e.msg))
 
1838
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1839
            % (where, re_string, e))
2211
1840
 
2212
1841
 
2213
1842
if sys.platform == "win32":
2267
1896
    anything goes wrong.
2268
1897
    """
2269
1898
    global _cached_local_concurrency
2270
 
 
2271
1899
    if _cached_local_concurrency is not None and use_cache:
2272
1900
        return _cached_local_concurrency
2273
1901
 
2274
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2275
 
    if concurrency is None:
2276
 
        try:
2277
 
            concurrency = _local_concurrency()
2278
 
        except (OSError, IOError):
2279
 
            pass
 
1902
    try:
 
1903
        concurrency = _local_concurrency()
 
1904
    except (OSError, IOError):
 
1905
        concurrency = None
2280
1906
    try:
2281
1907
        concurrency = int(concurrency)
2282
1908
    except (TypeError, ValueError):
2285
1911
        _cached_concurrency = concurrency
2286
1912
    return concurrency
2287
1913
 
2288
 
 
2289
 
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2290
 
    """A stream writer that doesn't decode str arguments."""
2291
 
 
2292
 
    def __init__(self, encode, stream, errors='strict'):
2293
 
        codecs.StreamWriter.__init__(self, stream, errors)
2294
 
        self.encode = encode
2295
 
 
2296
 
    def write(self, object):
2297
 
        if type(object) is str:
2298
 
            self.stream.write(object)
2299
 
        else:
2300
 
            data, _ = self.encode(object, self.errors)
2301
 
            self.stream.write(data)
2302
 
 
2303
1914
if sys.platform == 'win32':
2304
1915
    def open_file(filename, mode='r', bufsize=-1):
2305
1916
        """This function is used to override the ``open`` builtin.
2306
 
 
 
1917
        
2307
1918
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2308
1919
        child processes.  Deleting or renaming a closed file opened with this
2309
1920
        function is not blocking child processes.
2342
1953
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2343
1954
else:
2344
1955
    open_file = open
2345
 
 
2346
 
 
2347
 
def getuser_unicode():
2348
 
    """Return the username as unicode.
2349
 
    """
2350
 
    try:
2351
 
        user_encoding = get_user_encoding()
2352
 
        username = getpass.getuser().decode(user_encoding)
2353
 
    except UnicodeDecodeError:
2354
 
        raise errors.BzrError("Can't decode username as %s." % \
2355
 
                user_encoding)
2356
 
    return username