/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/osutils.py

  • Committer: Martin
  • Date: 2017-05-24 14:51:33 UTC
  • mto: This revision was merged to the branch mainline in revision 6632.
  • Revision ID: gzlist@googlemail.com-20170524145133-0oj70fjzd67if2ef
Fix test failures and issues with run with python -Werror

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
23
import sys
22
24
import time
23
25
import codecs
24
26
 
25
 
from bzrlib.lazy_import import lazy_import
 
27
from .lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
from datetime import datetime
28
 
import errno
29
 
from ntpath import (abspath as _nt_abspath,
30
 
                    join as _nt_join,
31
 
                    normpath as _nt_normpath,
32
 
                    realpath as _nt_realpath,
33
 
                    splitdrive as _nt_splitdrive,
34
 
                    )
 
30
from datetime import timedelta
 
31
import getpass
 
32
import locale
 
33
import ntpath
35
34
import posixpath
 
35
import select
 
36
# We need to import both shutil and rmtree as we export the later on posix
 
37
# and need the former on windows
36
38
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
39
from shutil import rmtree
40
40
import socket
41
41
import subprocess
 
42
# We need to import both tempfile and mkdtemp as we export the later on posix
 
43
# and need the former on windows
42
44
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
45
from tempfile import mkdtemp
46
46
import unicodedata
47
47
 
48
 
from bzrlib import (
 
48
from breezy import (
49
49
    cache_utf8,
 
50
    config,
50
51
    errors,
51
52
    trace,
52
53
    win32utils,
53
54
    )
 
55
from breezy.i18n import gettext
54
56
""")
55
57
 
56
 
from bzrlib.symbol_versioning import (
 
58
from .sixish import (
 
59
    PY3,
 
60
    text_type,
 
61
    )
 
62
from .symbol_versioning import (
 
63
    DEPRECATED_PARAMETER,
57
64
    deprecated_function,
58
65
    deprecated_in,
59
 
    )
60
 
 
61
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
62
 
# of 2.5
63
 
if sys.version_info < (2, 5):
64
 
    import md5 as _mod_md5
65
 
    md5 = _mod_md5.new
66
 
    import sha as _mod_sha
67
 
    sha = _mod_sha.new
68
 
else:
69
 
    from hashlib import (
70
 
        md5,
71
 
        sha1 as sha,
72
 
        )
73
 
 
74
 
 
75
 
import bzrlib
76
 
from bzrlib import symbol_versioning
 
66
    deprecated_passed,
 
67
    warn as warn_deprecated,
 
68
    )
 
69
 
 
70
from hashlib import (
 
71
    md5,
 
72
    sha1 as sha,
 
73
    )
 
74
 
 
75
 
 
76
import breezy
 
77
from . import symbol_versioning, _fs_enc
77
78
 
78
79
 
79
80
# Cross platform wall-clock time functionality with decent resolution.
97
98
 
98
99
 
99
100
def get_unicode_argv():
 
101
    if PY3:
 
102
        return sys.argv[1:]
100
103
    try:
101
104
        user_encoding = get_user_encoding()
102
105
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
106
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
107
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
108
            "application locale.").format(a, user_encoding))
106
109
 
107
110
 
108
111
def make_readonly(filename):
109
112
    """Make a filename read-only."""
110
113
    mod = os.lstat(filename).st_mode
111
114
    if not stat.S_ISLNK(mod):
112
 
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
115
        mod = mod & 0o777555
 
116
        chmod_if_possible(filename, mod)
114
117
 
115
118
 
116
119
def make_writable(filename):
117
120
    mod = os.lstat(filename).st_mode
118
121
    if not stat.S_ISLNK(mod):
119
 
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
122
        mod = mod | 0o200
 
123
        chmod_if_possible(filename, mod)
 
124
 
 
125
 
 
126
def chmod_if_possible(filename, mode):
 
127
    # Set file mode if that can be safely done.
 
128
    # Sometimes even on unix the filesystem won't allow it - see
 
129
    # https://bugs.launchpad.net/bzr/+bug/606537
 
130
    try:
 
131
        # It is probably faster to just do the chmod, rather than
 
132
        # doing a stat, and then trying to compare
 
133
        os.chmod(filename, mode)
 
134
    except (IOError, OSError) as e:
 
135
        # Permission/access denied seems to commonly happen on smbfs; there's
 
136
        # probably no point warning about it.
 
137
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
138
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
139
            trace.mutter("ignore error on chmod of %r: %r" % (
 
140
                filename, e))
 
141
            return
 
142
        raise
121
143
 
122
144
 
123
145
def minimum_path_selection(paths):
198
220
            stat = getattr(os, 'lstat', os.stat)
199
221
            stat(f)
200
222
            return True
201
 
        except OSError, e:
 
223
        except OSError as e:
202
224
            if e.errno == errno.ENOENT:
203
225
                return False;
204
226
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
227
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
228
 
207
229
 
208
230
def fancy_rename(old, new, rename_func, unlink_func):
232
254
    file_existed = False
233
255
    try:
234
256
        rename_func(new, tmp_name)
235
 
    except (errors.NoSuchFile,), e:
 
257
    except (errors.NoSuchFile,) as e:
236
258
        pass
237
 
    except IOError, e:
 
259
    except IOError as e:
238
260
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
261
        # function raises an IOError with errno is None when a rename fails.
240
262
        # This then gets caught here.
241
263
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
242
264
            raise
243
 
    except Exception, e:
 
265
    except Exception as e:
244
266
        if (getattr(e, 'errno', None) is None
245
267
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
246
268
            raise
247
269
    else:
248
270
        file_existed = True
249
271
 
250
 
    failure_exc = None
251
272
    success = False
252
273
    try:
253
 
        try:
254
 
            # This may throw an exception, in which case success will
255
 
            # not be set.
256
 
            rename_func(old, new)
257
 
            success = True
258
 
        except (IOError, OSError), e:
259
 
            # source and target may be aliases of each other (e.g. on a
260
 
            # case-insensitive filesystem), so we may have accidentally renamed
261
 
            # source by when we tried to rename target
262
 
            failure_exc = sys.exc_info()
263
 
            if (file_existed and e.errno in (None, errno.ENOENT)
264
 
                and old.lower() == new.lower()):
265
 
                # source and target are the same file on a case-insensitive
266
 
                # filesystem, so we don't generate an exception
267
 
                failure_exc = None
 
274
        # This may throw an exception, in which case success will
 
275
        # not be set.
 
276
        rename_func(old, new)
 
277
        success = True
 
278
    except (IOError, OSError) as e:
 
279
        # source and target may be aliases of each other (e.g. on a
 
280
        # case-insensitive filesystem), so we may have accidentally renamed
 
281
        # source by when we tried to rename target
 
282
        if (file_existed and e.errno in (None, errno.ENOENT)
 
283
            and old.lower() == new.lower()):
 
284
            # source and target are the same file on a case-insensitive
 
285
            # filesystem, so we don't generate an exception
 
286
            pass
 
287
        else:
 
288
            raise
268
289
    finally:
269
290
        if file_existed:
270
291
            # If the file used to exist, rename it back into place
273
294
                unlink_func(tmp_name)
274
295
            else:
275
296
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
297
 
279
298
 
280
299
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
300
# choke on a Unicode string containing a relative path if
282
301
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
302
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
303
def _posix_abspath(path):
286
304
    # jam 20060426 rather than encoding to fsencoding
287
305
    # copy posixpath.abspath, but use os.getcwdu instead
288
306
    if not posixpath.isabs(path):
289
307
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
308
    return _posix_normpath(path)
291
309
 
292
310
 
293
311
def _posix_realpath(path):
294
312
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
313
 
296
314
 
 
315
def _posix_normpath(path):
 
316
    path = posixpath.normpath(path)
 
317
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
318
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
319
    # leading slashes must not be simplified to one, and only if there are 3 or
 
320
    # more should they be simplified as one. So we treat the leading 2 slashes
 
321
    # as a special case here by simply removing the first slash, as we consider
 
322
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
323
    # This is not a paranoid precaution, as we notably get paths like this when
 
324
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
325
    if path.startswith('//'):
 
326
        path = path[1:]
 
327
    return path
 
328
 
 
329
 
 
330
def _posix_path_from_environ(key):
 
331
    """Get unicode path from `key` in environment or None if not present
 
332
 
 
333
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
334
    so a path that raises BadFilenameEncoding here may still be accessible.
 
335
    """
 
336
    val = os.environ.get(key, None)
 
337
    if val is None:
 
338
        return val
 
339
    try:
 
340
        return val.decode(_fs_enc)
 
341
    except UnicodeDecodeError:
 
342
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
343
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
344
 
 
345
 
 
346
def _posix_get_home_dir():
 
347
    """Get the home directory of the current user as a unicode path"""
 
348
    path = posixpath.expanduser("~")
 
349
    try:
 
350
        return path.decode(_fs_enc)
 
351
    except AttributeError:
 
352
        return path
 
353
    except UnicodeDecodeError:
 
354
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
355
 
 
356
 
 
357
def _posix_getuser_unicode():
 
358
    """Get username from environment or password database as unicode"""
 
359
    name = getpass.getuser()
 
360
    user_encoding = get_user_encoding()
 
361
    try:
 
362
        return name.decode(user_encoding)
 
363
    except UnicodeDecodeError:
 
364
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
365
            "application locale." % (name, user_encoding))
 
366
 
 
367
 
297
368
def _win32_fixdrive(path):
298
369
    """Force drive letters to be consistent.
299
370
 
303
374
    running python.exe under cmd.exe return capital C:\\
304
375
    running win32 python inside a cygwin shell returns lowercase c:\\
305
376
    """
306
 
    drive, path = _nt_splitdrive(path)
 
377
    drive, path = ntpath.splitdrive(path)
307
378
    return drive.upper() + path
308
379
 
309
380
 
310
381
def _win32_abspath(path):
311
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
312
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
382
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
383
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
384
 
314
385
 
315
386
def _win98_abspath(path):
326
397
    #   /path       => C:/path
327
398
    path = unicode(path)
328
399
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
400
    drive = ntpath.splitdrive(path)[0]
330
401
    if drive == '' and path[:2] not in('//','\\\\'):
331
 
        cwd = os.getcwdu()
 
402
        cwd = _getcwd()
332
403
        # we cannot simply os.path.join cwd and path
333
404
        # because os.path.join('C:','/path') produce '/path'
334
405
        # and this is incorrect
335
406
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
407
            cwd = ntpath.splitdrive(cwd)[0]
337
408
            path = path[1:]
338
409
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
410
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
411
 
341
412
 
342
413
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
414
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
415
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
416
 
346
417
 
347
418
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
419
    return ntpath.join(*args).replace('\\', '/')
349
420
 
350
421
 
351
422
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
423
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
424
 
354
425
 
355
426
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
427
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
428
 
358
429
 
359
430
def _win32_mkdtemp(*args, **kwargs):
360
431
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
432
 
362
433
 
363
 
def _add_rename_error_details(e, old, new):
364
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
365
 
        % (old, new, e.strerror))
366
 
    new_e.filename = old
367
 
    new_e.to_filename = new
368
 
    return new_e
369
 
 
370
 
 
371
434
def _win32_rename(old, new):
372
435
    """We expect to be able to atomically replace 'new' with old.
373
436
 
375
438
    and then deleted.
376
439
    """
377
440
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
441
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
442
    except OSError as e:
380
443
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
444
            # If we try to rename a non-existant file onto cwd, we get
382
445
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
449
        raise
387
450
 
388
451
 
389
 
def _wrapped_rename(old, new):
390
 
    """Rename a file or directory"""
391
 
    try:
392
 
        os.rename(old, new)
393
 
    except (IOError, OSError), e:
394
 
        # this is eventually called by all rename-like functions, so should 
395
 
        # catch all of them
396
 
        raise _add_rename_error_details(e, old, new)
397
 
 
398
 
 
399
452
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
453
    return unicodedata.normalize('NFC', _getcwd())
 
454
 
 
455
 
 
456
def _rename_wrap_exception(rename_func):
 
457
    """Adds extra information to any exceptions that come from rename().
 
458
 
 
459
    The exception has an updated message and 'old_filename' and 'new_filename'
 
460
    attributes.
 
461
    """
 
462
 
 
463
    def _rename_wrapper(old, new):
 
464
        try:
 
465
            rename_func(old, new)
 
466
        except OSError as e:
 
467
            detailed_error = OSError(e.errno, e.strerror +
 
468
                                " [occurred when renaming '%s' to '%s']" %
 
469
                                (old, new))
 
470
            detailed_error.old_filename = old
 
471
            detailed_error.new_filename = new
 
472
            raise detailed_error
 
473
 
 
474
    return _rename_wrapper
 
475
 
 
476
 
 
477
if sys.version_info > (3,):
 
478
    _getcwd = os.getcwd
 
479
else:
 
480
    _getcwd = os.getcwdu
 
481
 
 
482
 
 
483
# Default rename wraps os.rename()
 
484
rename = _rename_wrap_exception(os.rename)
402
485
 
403
486
# Default is to just use the python builtins, but these can be rebound on
404
487
# particular platforms.
405
488
abspath = _posix_abspath
406
489
realpath = _posix_realpath
407
490
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
491
normpath = _posix_normpath
 
492
path_from_environ = _posix_path_from_environ
 
493
_get_home_dir = _posix_get_home_dir
 
494
getuser_unicode = _posix_getuser_unicode
 
495
getcwd = _getcwd
411
496
dirname = os.path.dirname
412
497
basename = os.path.basename
413
498
split = os.path.split
414
499
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
500
# These were already lazily imported into local scope
416
501
# mkdtemp = tempfile.mkdtemp
417
502
# rmtree = shutil.rmtree
 
503
lstat = os.lstat
 
504
fstat = os.fstat
 
505
 
 
506
def wrap_stat(st):
 
507
    return st
 
508
 
418
509
 
419
510
MIN_ABS_PATHLENGTH = 1
420
511
 
429
520
    normpath = _win32_normpath
430
521
    getcwd = _win32_getcwd
431
522
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
523
    rename = _rename_wrap_exception(_win32_rename)
 
524
    try:
 
525
        from . import _walkdirs_win32
 
526
    except ImportError:
 
527
        pass
 
528
    else:
 
529
        lstat = _walkdirs_win32.lstat
 
530
        fstat = _walkdirs_win32.fstat
 
531
        wrap_stat = _walkdirs_win32.wrap_stat
433
532
 
434
533
    MIN_ABS_PATHLENGTH = 3
435
534
 
453
552
    f = win32utils.get_unicode_argv     # special function or None
454
553
    if f is not None:
455
554
        get_unicode_argv = f
 
555
    path_from_environ = win32utils.get_environ_unicode
 
556
    _get_home_dir = win32utils.get_home_location
 
557
    getuser_unicode = win32utils.get_user_name
456
558
 
457
559
elif sys.platform == 'darwin':
458
560
    getcwd = _mac_getcwd
459
561
 
460
562
 
461
 
def get_terminal_encoding():
 
563
def get_terminal_encoding(trace=False):
462
564
    """Find the best encoding for printing to the screen.
463
565
 
464
566
    This attempts to check both sys.stdout and sys.stdin to see
470
572
 
471
573
    On my standard US Windows XP, the preferred encoding is
472
574
    cp1252, but the console is cp437
 
575
 
 
576
    :param trace: If True trace the selected encoding via mutter().
473
577
    """
474
 
    from bzrlib.trace import mutter
 
578
    from .trace import mutter
475
579
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
580
    if not output_encoding:
477
581
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
582
        if not input_encoding:
479
583
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
584
            if trace:
 
585
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
586
                   output_encoding)
482
587
        else:
483
588
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
589
            if trace:
 
590
                mutter('encoding stdout as sys.stdin encoding %r',
 
591
                    output_encoding)
485
592
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
593
        if trace:
 
594
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
595
    if output_encoding == 'cp0':
488
596
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
597
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
598
        if trace:
 
599
            mutter('cp0 is invalid encoding.'
491
600
               ' encoding stdout as osutils.get_user_encoding() %r',
492
601
               output_encoding)
493
602
    # check encoding
494
603
    try:
495
604
        codecs.lookup(output_encoding)
496
605
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
606
        sys.stderr.write('brz: warning:'
498
607
                         ' unknown terminal encoding %s.\n'
499
608
                         '  Using encoding %s instead.\n'
500
609
                         % (output_encoding, get_user_encoding())
519
628
def isdir(f):
520
629
    """True if f is an accessible directory."""
521
630
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
631
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
632
    except OSError:
524
633
        return False
525
634
 
527
636
def isfile(f):
528
637
    """True if f is a regular file."""
529
638
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
639
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
640
    except OSError:
532
641
        return False
533
642
 
534
643
def islink(f):
535
644
    """True if f is a symlink."""
536
645
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
646
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
647
    except OSError:
539
648
        return False
540
649
 
728
837
            return True
729
838
 
730
839
 
 
840
def gmtime(seconds=None):
 
841
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
842
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
843
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
844
    """
 
845
    if seconds is None:
 
846
        seconds = time.time()
 
847
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
848
 
 
849
 
731
850
def local_time_offset(t=None):
732
851
    """Return offset of local zone from GMT, either at present or at time t."""
733
852
    if t is None:
773
892
    """
774
893
    if offset is None:
775
894
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
895
    tt = gmtime(t + offset)
777
896
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
897
    date_str = time.strftime(date_fmt, tt)
779
898
    offset_str = _cache.get(offset, None)
798
917
    (date_fmt, tt, offset_str) = \
799
918
               _format_date(t, offset, timezone, date_fmt, show_offset)
800
919
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
920
    if not isinstance(date_str, text_type):
802
921
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
922
    return date_str + offset_str
804
923
 
805
924
 
806
925
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
926
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
927
        tt = gmtime(t)
809
928
        offset = 0
810
929
    elif timezone == 'original':
811
930
        if offset is None:
812
931
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
932
        tt = gmtime(t + offset)
814
933
    elif timezone == 'local':
815
934
        tt = time.localtime(t)
816
935
        offset = local_time_offset(t)
826
945
 
827
946
 
828
947
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
948
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
949
 
831
950
 
832
951
def format_delta(delta):
880
999
 
881
1000
def filesize(f):
882
1001
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
884
 
 
885
 
 
886
 
# Define rand_bytes based on platform.
887
 
try:
888
 
    # Python 2.4 and later have os.urandom,
889
 
    # but it doesn't work on some arches
890
 
    os.urandom(1)
891
 
    rand_bytes = os.urandom
892
 
except (NotImplementedError, AttributeError):
893
 
    # If python doesn't have os.urandom, or it doesn't work,
894
 
    # then try to first pull random data from /dev/urandom
 
1002
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
1003
 
 
1004
 
 
1005
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
1006
# override if it doesn't work. Avoid checking on windows where there is
 
1007
# significant initialisation cost that can be avoided for some bzr calls.
 
1008
 
 
1009
rand_bytes = os.urandom
 
1010
 
 
1011
if rand_bytes.__module__ != "nt":
895
1012
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
1013
        rand_bytes(1)
 
1014
    except NotImplementedError:
899
1015
        # not well seeded, but better than nothing
900
1016
        def rand_bytes(n):
901
1017
            import random
931
1047
    rps = []
932
1048
    for f in ps:
933
1049
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1050
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1051
        elif (f == '.') or (f == ''):
936
1052
            pass
937
1053
        else:
942
1058
def joinpath(p):
943
1059
    for f in p:
944
1060
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1061
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1062
    return pathjoin(*p)
947
1063
 
948
1064
 
949
1065
def parent_directories(filename):
950
1066
    """Return the list of parent directories, deepest first.
951
 
    
 
1067
 
952
1068
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1069
    """
954
1070
    parents = []
970
1086
    implementation should be loaded instead::
971
1087
 
972
1088
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1089
    >>>     import breezy._fictional_extension_pyx
974
1090
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1091
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1092
    >>>     import breezy._fictional_extension_py
977
1093
    """
978
1094
    # NB: This docstring is just an example, not a doctest, because doctest
979
1095
    # currently can't cope with the use of lazy imports in this namespace --
980
1096
    # mbp 20090729
981
 
    
 
1097
 
982
1098
    # This currently doesn't report the failure at the time it occurs, because
983
1099
    # they tend to happen very early in startup when we can't check config
984
1100
    # files etc, and also we want to report all failures but not spam the user
985
1101
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1102
    exception_str = str(exception)
988
1103
    if exception_str not in _extension_load_failures:
989
1104
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1108
def report_extension_load_failures():
994
1109
    if not _extension_load_failures:
995
1110
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1111
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1112
        return
999
1113
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1114
    from .trace import warning
1001
1115
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1116
        "brz: warning: some compiled extensions could not be loaded; "
1003
1117
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1004
1118
    # we no longer show the specific missing extensions here, because it makes
1005
1119
    # the message too long and scary - see
1007
1121
 
1008
1122
 
1009
1123
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1124
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1125
except ImportError as e:
1012
1126
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1127
    from ._chunks_to_lines_py import chunks_to_lines
1014
1128
 
1015
1129
 
1016
1130
def split_lines(s):
1047
1161
        return
1048
1162
    try:
1049
1163
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1164
    except (OSError, IOError) as e:
1051
1165
        if e.errno != errno.EXDEV:
1052
1166
            raise
1053
1167
        shutil.copyfile(src, dest)
1054
1168
 
1055
1169
 
1056
1170
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1171
    """Delete a file, symlink or directory.
 
1172
 
1059
1173
    Will delete even if readonly.
1060
1174
    """
1061
1175
    try:
1062
1176
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1177
    except (OSError, IOError) as e:
1064
1178
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1179
            # make writable and try again
1066
1180
            try:
1162
1276
 
1163
1277
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1278
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1279
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1280
            % (base,))
1167
1281
 
1168
1282
    rp = abspath(path)
1250
1364
    # but for now, we haven't optimized...
1251
1365
    return [canonical_relpath(base, p) for p in paths]
1252
1366
 
 
1367
 
 
1368
def decode_filename(filename):
 
1369
    """Decode the filename using the filesystem encoding
 
1370
 
 
1371
    If it is unicode, it is returned.
 
1372
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1373
    fails, a errors.BadFilenameEncoding exception is raised.
 
1374
    """
 
1375
    if isinstance(filename, text_type):
 
1376
        return filename
 
1377
    try:
 
1378
        return filename.decode(_fs_enc)
 
1379
    except UnicodeDecodeError:
 
1380
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1381
 
 
1382
 
1253
1383
def safe_unicode(unicode_or_utf8_string):
1254
1384
    """Coerce unicode_or_utf8_string into unicode.
1255
1385
 
1257
1387
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1388
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1389
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1390
    if isinstance(unicode_or_utf8_string, text_type):
1261
1391
        return unicode_or_utf8_string
1262
1392
    try:
1263
1393
        return unicode_or_utf8_string.decode('utf8')
1338
1468
def normalizes_filenames():
1339
1469
    """Return True if this platform normalizes unicode filenames.
1340
1470
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1471
    Only Mac OSX.
1342
1472
    """
1343
1473
    return _platform_normalizes_filenames
1344
1474
 
1349
1479
    On platforms where the system normalizes filenames (Mac OSX),
1350
1480
    you can access a file by any path which will normalize correctly.
1351
1481
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1482
    (everything else), you have to access a file by its exact path.
1353
1483
 
1354
1484
    Internally, bzr only supports NFC normalization, since that is
1355
1485
    the standard for XML documents.
1417
1547
terminal_width() returns None.
1418
1548
"""
1419
1549
 
 
1550
# Keep some state so that terminal_width can detect if _terminal_size has
 
1551
# returned a different size since the process started.  See docstring and
 
1552
# comments of terminal_width for details.
 
1553
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1554
_terminal_size_state = 'no_data'
 
1555
_first_terminal_size = None
1420
1556
 
1421
1557
def terminal_width():
1422
1558
    """Return terminal width.
1424
1560
    None is returned if the width can't established precisely.
1425
1561
 
1426
1562
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1563
    - if BRZ_COLUMNS is set, returns its value
1428
1564
    - if there is no controlling terminal, returns None
 
1565
    - query the OS, if the queried size has changed since the last query,
 
1566
      return its value,
1429
1567
    - if COLUMNS is set, returns its value,
 
1568
    - if the OS has a value (even though it's never changed), return its value.
1430
1569
 
1431
1570
    From there, we need to query the OS to get the size of the controlling
1432
1571
    terminal.
1433
1572
 
1434
 
    Unices:
 
1573
    On Unices we query the OS by:
1435
1574
    - get termios.TIOCGWINSZ
1436
1575
    - if an error occurs or a negative value is obtained, returns None
1437
1576
 
1438
 
    Windows:
1439
 
    
 
1577
    On Windows we query the OS by:
1440
1578
    - win32utils.get_console_size() decides,
1441
1579
    - returns None on error (provided default value)
1442
1580
    """
 
1581
    # Note to implementors: if changing the rules for determining the width,
 
1582
    # make sure you've considered the behaviour in these cases:
 
1583
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1584
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1585
    #    0,0.
 
1586
    #  - (add more interesting cases here, if you find any)
 
1587
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1588
    # but we don't want to register a signal handler because it is impossible
 
1589
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1590
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1591
    # time so we can notice if the reported size has changed, which should have
 
1592
    # a similar effect.
1443
1593
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1594
    # If BRZ_COLUMNS is set, take it, user is always right
 
1595
    # Except if they specified 0 in which case, impose no limit here
1445
1596
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1597
        width = int(os.environ['BRZ_COLUMNS'])
1447
1598
    except (KeyError, ValueError):
1448
 
        pass
 
1599
        width = None
 
1600
    if width is not None:
 
1601
        if width > 0:
 
1602
            return width
 
1603
        else:
 
1604
            return None
1449
1605
 
1450
1606
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
1452
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1607
    if isatty is None or not isatty():
 
1608
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1609
        return None
1454
1610
 
1455
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1456
 
    # given terminal, the application can decide to set COLUMNS to a lower
1457
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1611
    # Query the OS
 
1612
    width, height = os_size = _terminal_size(None, None)
 
1613
    global _first_terminal_size, _terminal_size_state
 
1614
    if _terminal_size_state == 'no_data':
 
1615
        _first_terminal_size = os_size
 
1616
        _terminal_size_state = 'unchanged'
 
1617
    elif (_terminal_size_state == 'unchanged' and
 
1618
          _first_terminal_size != os_size):
 
1619
        _terminal_size_state = 'changed'
 
1620
 
 
1621
    # If the OS claims to know how wide the terminal is, and this value has
 
1622
    # ever changed, use that.
 
1623
    if _terminal_size_state == 'changed':
 
1624
        if width is not None and width > 0:
 
1625
            return width
 
1626
 
 
1627
    # If COLUMNS is set, use it.
1458
1628
    try:
1459
1629
        return int(os.environ['COLUMNS'])
1460
1630
    except (KeyError, ValueError):
1461
1631
        pass
1462
1632
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1633
    # Finally, use an unchanged size from the OS, if we have one.
 
1634
    if _terminal_size_state == 'unchanged':
 
1635
        if width is not None and width > 0:
 
1636
            return width
1467
1637
 
1468
 
    return width
 
1638
    # The width could not be determined.
 
1639
    return None
1469
1640
 
1470
1641
 
1471
1642
def _win32_terminal_size(width, height):
1498
1669
    _terminal_size = _ioctl_terminal_size
1499
1670
 
1500
1671
 
1501
 
def _terminal_size_changed(signum, frame):
1502
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
 
    width, height = _terminal_size(None, None)
1504
 
    if width is not None:
1505
 
        os.environ['COLUMNS'] = str(width)
1506
 
 
1507
 
 
1508
 
_registered_sigwinch = False
1509
 
def watch_sigwinch():
1510
 
    """Register for SIGWINCH, once and only once.
1511
 
 
1512
 
    Do nothing if the signal module is not available.
1513
 
    """
1514
 
    global _registered_sigwinch
1515
 
    if not _registered_sigwinch:
1516
 
        try:
1517
 
            import signal
1518
 
            if getattr(signal, "SIGWINCH", None) is not None:
1519
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1520
 
        except ImportError:
1521
 
            # python doesn't provide signal support, nothing we can do about it
1522
 
            pass
1523
 
        _registered_sigwinch = True
1524
 
 
1525
 
 
1526
1672
def supports_executable():
1527
1673
    return sys.platform != "win32"
1528
1674
 
1553
1699
        if orig_val is not None:
1554
1700
            del os.environ[env_variable]
1555
1701
    else:
1556
 
        if isinstance(value, unicode):
 
1702
        if not PY3 and isinstance(value, text_type):
1557
1703
            value = value.encode(get_user_encoding())
1558
1704
        os.environ[env_variable] = value
1559
1705
    return orig_val
1651
1797
        dirblock = []
1652
1798
        append = dirblock.append
1653
1799
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1800
            names = sorted(map(decode_filename, _listdir(top)))
 
1801
        except OSError as e:
1656
1802
            if not _is_error_enotdir(e):
1657
1803
                raise
1658
1804
        else:
1711
1857
    """
1712
1858
    global _selected_dir_reader
1713
1859
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1860
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1861
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1862
            # TODO: We possibly could support Win98 by falling back to the
1719
1864
            #       but that gets a bit tricky, and requires custom compiling
1720
1865
            #       for win98 anyway.
1721
1866
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1867
                from ._walkdirs_win32 import Win32ReadDir
1723
1868
                _selected_dir_reader = Win32ReadDir()
1724
1869
            except ImportError:
1725
1870
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1871
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1872
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1873
                from ._readdir_pyx import UTF8DirReader
1730
1874
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1875
            except ImportError as e:
1732
1876
                failed_to_load_extension(e)
1733
1877
                pass
1734
1878
 
1864
2008
    try:
1865
2009
        s = os.stat(src)
1866
2010
        chown(dst, s.st_uid, s.st_gid)
1867
 
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
2011
    except OSError as e:
 
2012
        trace.warning(
 
2013
            'Unable to copy ownership from "%s" to "%s". '
 
2014
            'You may want to set it manually.', src, dst)
 
2015
        trace.log_exception_quietly()
1869
2016
 
1870
2017
 
1871
2018
def path_prefix_key(path):
1886
2033
_cached_user_encoding = None
1887
2034
 
1888
2035
 
1889
 
def get_user_encoding(use_cache=True):
 
2036
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
2037
    """Find out what the preferred user encoding is.
1891
2038
 
1892
2039
    This is generally the encoding that is used for command line parameters
1893
2040
    and file contents. This may be different from the terminal encoding
1894
2041
    or the filesystem encoding.
1895
2042
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
2043
    :return: A string defining the preferred user encoding
1901
2044
    """
1902
2045
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2046
    if deprecated_passed(use_cache):
 
2047
        warn_deprecated("use_cache should only have been used for tests",
 
2048
            DeprecationWarning, stacklevel=2) 
 
2049
    if _cached_user_encoding is not None:
1904
2050
        return _cached_user_encoding
1905
2051
 
1906
 
    if sys.platform == 'darwin':
1907
 
        # python locale.getpreferredencoding() always return
1908
 
        # 'mac-roman' on darwin. That's a lie.
1909
 
        sys.platform = 'posix'
1910
 
        try:
1911
 
            if os.environ.get('LANG', None) is None:
1912
 
                # If LANG is not set, we end up with 'ascii', which is bad
1913
 
                # ('mac-roman' is more than ascii), so we set a default which
1914
 
                # will give us UTF-8 (which appears to work in all cases on
1915
 
                # OSX). Users are still free to override LANG of course, as
1916
 
                # long as it give us something meaningful. This work-around
1917
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1918
 
                # work with them too -- vila 20080908
1919
 
                os.environ['LANG'] = 'en_US.UTF-8'
1920
 
            import locale
1921
 
        finally:
1922
 
            sys.platform = 'darwin'
 
2052
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2053
        # Use the existing locale settings and call nl_langinfo directly
 
2054
        # rather than going through getpreferredencoding. This avoids
 
2055
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2056
        # possibility of the setlocale call throwing an error.
 
2057
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2058
    else:
1924
 
        import locale
 
2059
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2060
        user_encoding = locale.getpreferredencoding(False)
1925
2061
 
1926
2062
    try:
1927
 
        user_encoding = locale.getpreferredencoding()
1928
 
    except locale.Error, e:
1929
 
        sys.stderr.write('bzr: warning: %s\n'
1930
 
                         '  Could not determine what text encoding to use.\n'
1931
 
                         '  This error usually means your Python interpreter\n'
1932
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1933
 
                         "  Continuing with ascii encoding.\n"
1934
 
                         % (e, os.environ.get('LANG')))
1935
 
        user_encoding = 'ascii'
1936
 
 
1937
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
 
    # treat that as ASCII, and not support printing unicode characters to the
1939
 
    # console.
1940
 
    #
1941
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1942
 
    if user_encoding in (None, 'cp0', ''):
1943
 
        user_encoding = 'ascii'
1944
 
    else:
1945
 
        # check encoding
1946
 
        try:
1947
 
            codecs.lookup(user_encoding)
1948
 
        except LookupError:
1949
 
            sys.stderr.write('bzr: warning:'
 
2063
        user_encoding = codecs.lookup(user_encoding).name
 
2064
    except LookupError:
 
2065
        if user_encoding not in ("", "cp0"):
 
2066
            sys.stderr.write('brz: warning:'
1950
2067
                             ' unknown encoding %s.'
1951
2068
                             ' Continuing with ascii encoding.\n'
1952
2069
                             % user_encoding
1953
2070
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2071
        user_encoding = 'ascii'
 
2072
    else:
 
2073
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2074
        if user_encoding == 'ascii':
 
2075
            if sys.platform == 'darwin':
 
2076
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2077
                # encoding and previously had LANG set here if not present.
 
2078
                user_encoding = 'utf-8'
 
2079
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2080
            #                for some other posix platforms as well.
 
2081
 
 
2082
    _cached_user_encoding = user_encoding
1959
2083
    return user_encoding
1960
2084
 
1961
2085
 
 
2086
def get_diff_header_encoding():
 
2087
    return get_terminal_encoding()
 
2088
 
 
2089
 
1962
2090
def get_host_name():
1963
2091
    """Return the current unicode host name.
1964
2092
 
1966
2094
    behaves inconsistently on different platforms.
1967
2095
    """
1968
2096
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2097
        return win32utils.get_host_name()
1971
2098
    else:
1972
2099
        import socket
1979
2106
# data at once.
1980
2107
MAX_SOCKET_CHUNK = 64 * 1024
1981
2108
 
 
2109
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2110
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2111
    _eno = getattr(errno, _eno, None)
 
2112
    if _eno is not None:
 
2113
        _end_of_stream_errors.append(_eno)
 
2114
del _eno
 
2115
 
 
2116
 
1982
2117
def read_bytes_from_socket(sock, report_activity=None,
1983
2118
        max_read_size=MAX_SOCKET_CHUNK):
1984
2119
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2122
    empty string rather than raise an error), and repeats the recv if
1988
2123
    interrupted by a signal.
1989
2124
    """
1990
 
    while 1:
 
2125
    while True:
1991
2126
        try:
1992
2127
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2128
        except socket.error as e:
1994
2129
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2130
            if eno in _end_of_stream_errors:
1996
2131
                # The connection was closed by the other side.  Callers expect
1997
2132
                # an empty string to signal end-of-stream.
1998
2133
                return ""
2027
2162
 
2028
2163
def send_all(sock, bytes, report_activity=None):
2029
2164
    """Send all bytes on a socket.
2030
 
 
 
2165
 
2031
2166
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2167
    some platforms, and catches EINTR which may be thrown if the send is
2033
2168
    interrupted by a signal.
2034
2169
 
2035
2170
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2171
    and provides activity reporting.
2037
 
 
 
2172
 
2038
2173
    :param report_activity: Call this as bytes are read, see
2039
2174
        Transport._report_activity
2040
2175
    """
2043
2178
    while sent_total < byte_count:
2044
2179
        try:
2045
2180
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2181
        except (socket.error, IOError) as e:
 
2182
            if e.args[0] in _end_of_stream_errors:
 
2183
                raise errors.ConnectionReset(
 
2184
                    "Error trying to write to socket", e)
2047
2185
            if e.args[0] != errno.EINTR:
2048
2186
                raise
2049
2187
        else:
 
2188
            if sent == 0:
 
2189
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2190
                                             % (sock,))
2050
2191
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2192
            if report_activity is not None:
 
2193
                report_activity(sent, 'write')
 
2194
 
 
2195
 
 
2196
def connect_socket(address):
 
2197
    # Slight variation of the socket.create_connection() function (provided by
 
2198
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2199
    # provide it for previous python versions. Also, we don't use the timeout
 
2200
    # parameter (provided by the python implementation) so we don't implement
 
2201
    # it either).
 
2202
    err = socket.error('getaddrinfo returns an empty list')
 
2203
    host, port = address
 
2204
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2205
        af, socktype, proto, canonname, sa = res
 
2206
        sock = None
 
2207
        try:
 
2208
            sock = socket.socket(af, socktype, proto)
 
2209
            sock.connect(sa)
 
2210
            return sock
 
2211
 
 
2212
        except socket.error as err:
 
2213
            # 'err' is now the most recent error
 
2214
            if sock is not None:
 
2215
                sock.close()
 
2216
    raise err
2052
2217
 
2053
2218
 
2054
2219
def dereference_path(path):
2073
2238
def resource_string(package, resource_name):
2074
2239
    """Load a resource from a package and return it as a string.
2075
2240
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2241
    Note: Only packages that start with breezy are currently supported.
2077
2242
 
2078
2243
    This is designed to be a lightweight implementation of resource
2079
2244
    loading in a way which is API compatible with the same API from
2082
2247
    If and when pkg_resources becomes a standard library, this routine
2083
2248
    can delegate to it.
2084
2249
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2250
    # Check package name is within breezy
 
2251
    if package == "breezy":
2087
2252
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2253
    elif package.startswith("breezy."):
 
2254
        package = package[len("breezy."):].replace('.', os.sep)
2090
2255
        resource_relpath = pathjoin(package, resource_name)
2091
2256
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2257
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2258
 
2094
2259
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2260
    base = dirname(breezy.__file__)
2096
2261
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2262
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2263
    f = file(pathjoin(base, resource_relpath), "rU")
 
2264
    try:
 
2265
        return f.read()
 
2266
    finally:
 
2267
        f.close()
2101
2268
 
2102
2269
def file_kind_from_stat_mode_thunk(mode):
2103
2270
    global file_kind_from_stat_mode
2104
2271
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2272
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2273
            from ._readdir_pyx import UTF8DirReader
2107
2274
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2275
        except ImportError as e:
2109
2276
            # This is one time where we won't warn that an extension failed to
2110
2277
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2278
            from ._readdir_py import (
2112
2279
                _kind_from_mode as file_kind_from_stat_mode
2113
2280
                )
2114
2281
    return file_kind_from_stat_mode(mode)
2115
2282
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2283
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2284
def file_stat(f, _lstat=os.lstat):
2119
2285
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2286
        # XXX cache?
 
2287
        return _lstat(f)
 
2288
    except OSError as e:
2122
2289
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2290
            raise errors.NoSuchFile(f)
2124
2291
        raise
2125
2292
 
 
2293
def file_kind(f, _lstat=os.lstat):
 
2294
    stat_value = file_stat(f, _lstat)
 
2295
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2296
 
2127
2297
def until_no_eintr(f, *a, **kw):
2128
2298
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2299
 
2130
2300
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2301
    if EINTR does occur.  This is typically only true for low-level operations
2132
2302
    like os.read.  If in any doubt, don't use this.
2134
2304
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2305
    probably code in the Python standard library and other dependencies that
2136
2306
    may encounter EINTR if a signal arrives (and there is signal handler for
2137
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2307
    that signal).  So this function can reduce the impact for IO that breezy
2138
2308
    directly controls, but it is not a complete solution.
2139
2309
    """
2140
2310
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2311
    while True:
2142
2312
        try:
2143
2313
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2314
        except (IOError, OSError) as e:
2145
2315
            if e.errno == errno.EINTR:
2146
2316
                continue
2147
2317
            raise
2148
2318
 
2149
2319
 
 
2320
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2321
def re_compile_checked(re_string, flags=0, where=""):
2151
2322
    """Return a compiled re, or raise a sensible error.
2152
2323
 
2162
2333
        re_obj = re.compile(re_string, flags)
2163
2334
        re_obj.search("")
2164
2335
        return re_obj
2165
 
    except re.error, e:
 
2336
    except errors.InvalidPattern as e:
2166
2337
        if where:
2167
2338
            where = ' in ' + where
2168
2339
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2340
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2341
            % (where, e.msg))
2171
2342
 
2172
2343
 
2173
2344
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2345
    def getchar():
 
2346
        import msvcrt
2176
2347
        return msvcrt.getch()
2177
2348
else:
2178
 
    import tty
2179
 
    import termios
2180
2349
    def getchar():
 
2350
        import tty
 
2351
        import termios
2181
2352
        fd = sys.stdin.fileno()
2182
2353
        settings = termios.tcgetattr(fd)
2183
2354
        try:
2187
2358
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2359
        return ch
2189
2360
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2361
if sys.platform.startswith('linux'):
2192
2362
    def _local_concurrency():
2193
 
        concurrency = None
2194
 
        prefix = 'processor'
2195
 
        for line in file('/proc/cpuinfo', 'rb'):
2196
 
            if line.startswith(prefix):
2197
 
                concurrency = int(line[line.find(':')+1:]) + 1
2198
 
        return concurrency
 
2363
        try:
 
2364
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2365
        except (ValueError, OSError, AttributeError):
 
2366
            return None
2199
2367
elif sys.platform == 'darwin':
2200
2368
    def _local_concurrency():
2201
2369
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2370
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2371
elif "bsd" in sys.platform:
2204
2372
    def _local_concurrency():
2205
2373
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2374
                                stdout=subprocess.PIPE).communicate()[0]
2231
2399
    if _cached_local_concurrency is not None and use_cache:
2232
2400
        return _cached_local_concurrency
2233
2401
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2402
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2403
    if concurrency is None:
2236
2404
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2405
            import multiprocessing
 
2406
            concurrency = multiprocessing.cpu_count()
 
2407
        except (ImportError, NotImplementedError):
 
2408
            # multiprocessing is only available on Python >= 2.6
 
2409
            # and multiprocessing.cpu_count() isn't implemented on all
 
2410
            # platforms
 
2411
            try:
 
2412
                concurrency = _local_concurrency()
 
2413
            except (OSError, IOError):
 
2414
                pass
2240
2415
    try:
2241
2416
        concurrency = int(concurrency)
2242
2417
    except (TypeError, ValueError):
2254
2429
        self.encode = encode
2255
2430
 
2256
2431
    def write(self, object):
2257
 
        if type(object) is str:
 
2432
        if isinstance(object, str):
2258
2433
            self.stream.write(object)
2259
2434
        else:
2260
2435
            data, _ = self.encode(object, self.errors)
2263
2438
if sys.platform == 'win32':
2264
2439
    def open_file(filename, mode='r', bufsize=-1):
2265
2440
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2441
 
2267
2442
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2443
        child processes.  Deleting or renaming a closed file opened with this
2269
2444
        function is not blocking child processes.
2302
2477
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2478
else:
2304
2479
    open_file = open
 
2480
 
 
2481
 
 
2482
def available_backup_name(base, exists):
 
2483
    """Find a non-existing backup file name.
 
2484
 
 
2485
    This will *not* create anything, this only return a 'free' entry.  This
 
2486
    should be used for checking names in a directory below a locked
 
2487
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2488
    Leap) and generally discouraged.
 
2489
 
 
2490
    :param base: The base name.
 
2491
 
 
2492
    :param exists: A callable returning True if the path parameter exists.
 
2493
    """
 
2494
    counter = 1
 
2495
    name = "%s.~%d~" % (base, counter)
 
2496
    while exists(name):
 
2497
        counter += 1
 
2498
        name = "%s.~%d~" % (base, counter)
 
2499
    return name
 
2500
 
 
2501
 
 
2502
def set_fd_cloexec(fd):
 
2503
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2504
    support for this is not available.
 
2505
    """
 
2506
    try:
 
2507
        import fcntl
 
2508
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2509
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2510
    except (ImportError, AttributeError):
 
2511
        # Either the fcntl module or specific constants are not present
 
2512
        pass
 
2513
 
 
2514
 
 
2515
def find_executable_on_path(name):
 
2516
    """Finds an executable on the PATH.
 
2517
    
 
2518
    On Windows, this will try to append each extension in the PATHEXT
 
2519
    environment variable to the name, if it cannot be found with the name
 
2520
    as given.
 
2521
    
 
2522
    :param name: The base name of the executable.
 
2523
    :return: The path to the executable found or None.
 
2524
    """
 
2525
    if sys.platform == 'win32':
 
2526
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2527
        exts = [ext.lower() for ext in exts]
 
2528
        base, ext = os.path.splitext(name)
 
2529
        if ext != '':
 
2530
            if ext.lower() not in exts:
 
2531
                return None
 
2532
            name = base
 
2533
            exts = [ext]
 
2534
    else:
 
2535
        exts = ['']
 
2536
    path = os.environ.get('PATH')
 
2537
    if path is not None:
 
2538
        path = path.split(os.pathsep)
 
2539
        for ext in exts:
 
2540
            for d in path:
 
2541
                f = os.path.join(d, name) + ext
 
2542
                if os.access(f, os.X_OK):
 
2543
                    return f
 
2544
    if sys.platform == 'win32':
 
2545
        app_path = win32utils.get_app_path(name)
 
2546
        if app_path != name:
 
2547
            return app_path
 
2548
    return None
 
2549
 
 
2550
 
 
2551
def _posix_is_local_pid_dead(pid):
 
2552
    """True if pid doesn't correspond to live process on this machine"""
 
2553
    try:
 
2554
        # Special meaning of unix kill: just check if it's there.
 
2555
        os.kill(pid, 0)
 
2556
    except OSError as e:
 
2557
        if e.errno == errno.ESRCH:
 
2558
            # On this machine, and really not found: as sure as we can be
 
2559
            # that it's dead.
 
2560
            return True
 
2561
        elif e.errno == errno.EPERM:
 
2562
            # exists, though not ours
 
2563
            return False
 
2564
        else:
 
2565
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2566
            # Don't really know.
 
2567
            return False
 
2568
    else:
 
2569
        # Exists and our process: not dead.
 
2570
        return False
 
2571
 
 
2572
if sys.platform == "win32":
 
2573
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2574
else:
 
2575
    is_local_pid_dead = _posix_is_local_pid_dead
 
2576
 
 
2577
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2578
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2579
                      if getattr(errno, name, None) is not None]
 
2580
 
 
2581
 
 
2582
def fdatasync(fileno):
 
2583
    """Flush file contents to disk if possible.
 
2584
    
 
2585
    :param fileno: Integer OS file handle.
 
2586
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2587
    """
 
2588
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2589
    if fn is not None:
 
2590
        try:
 
2591
            fn(fileno)
 
2592
        except IOError as e:
 
2593
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2594
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2595
            # and reduce the chance of corruption-on-powerloss situations. It
 
2596
            # is not a mandatory call, so it is ok to suppress failures.
 
2597
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2598
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2599
                raise
 
2600
 
 
2601
 
 
2602
def ensure_empty_directory_exists(path, exception_class):
 
2603
    """Make sure a local directory exists and is empty.
 
2604
    
 
2605
    If it does not exist, it is created.  If it exists and is not empty, an
 
2606
    instance of exception_class is raised.
 
2607
    """
 
2608
    try:
 
2609
        os.mkdir(path)
 
2610
    except OSError as e:
 
2611
        if e.errno != errno.EEXIST:
 
2612
            raise
 
2613
        if os.listdir(path) != []:
 
2614
            raise exception_class(path)
 
2615
 
 
2616
 
 
2617
def is_environment_error(evalue):
 
2618
    """True if exception instance is due to a process environment issue
 
2619
 
 
2620
    This includes OSError and IOError, but also other errors that come from
 
2621
    the operating system or core libraries but are not subclasses of those.
 
2622
    """
 
2623
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2624
        return True
 
2625
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2626
        return True
 
2627
    return False