/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-06-05 20:48:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6658.
  • Revision ID: gzlist@googlemail.com-20170605204831-20accykspjcrx0a8
Apply 2to3 dict fixer and clean up resulting mess using view helpers

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
 
30
from datetime import timedelta
29
31
import getpass
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
 
                    )
 
32
import locale
 
33
import ntpath
36
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
37
38
import shutil
38
 
from shutil import (
39
 
    rmtree,
40
 
    )
 
39
from shutil import rmtree
41
40
import socket
42
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
43
44
import tempfile
44
 
from tempfile import (
45
 
    mkdtemp,
46
 
    )
 
45
from tempfile import mkdtemp
47
46
import unicodedata
48
47
 
49
 
from bzrlib import (
50
 
    cache_utf8,
 
48
from breezy import (
 
49
    config,
51
50
    errors,
52
51
    trace,
53
52
    win32utils,
54
53
    )
 
54
from breezy.i18n import gettext
55
55
""")
56
56
 
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    deprecated_in,
60
 
    )
61
 
 
62
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
 
# of 2.5
64
 
if sys.version_info < (2, 5):
65
 
    import md5 as _mod_md5
66
 
    md5 = _mod_md5.new
67
 
    import sha as _mod_sha
68
 
    sha = _mod_sha.new
69
 
else:
70
 
    from hashlib import (
71
 
        md5,
72
 
        sha1 as sha,
73
 
        )
74
 
 
75
 
 
76
 
import bzrlib
77
 
from bzrlib import symbol_versioning
 
57
from .sixish import (
 
58
    PY3,
 
59
    text_type,
 
60
    )
 
61
 
 
62
from hashlib import (
 
63
    md5,
 
64
    sha1 as sha,
 
65
    )
 
66
 
 
67
 
 
68
import breezy
 
69
from . import _fs_enc
78
70
 
79
71
 
80
72
# Cross platform wall-clock time functionality with decent resolution.
98
90
 
99
91
 
100
92
def get_unicode_argv():
 
93
    if PY3:
 
94
        return sys.argv[1:]
101
95
    try:
102
96
        user_encoding = get_user_encoding()
103
97
        return [a.decode(user_encoding) for a in sys.argv[1:]]
104
98
    except UnicodeDecodeError:
105
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
106
 
                                                            "encoding." % a))
 
99
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
100
            "application locale.").format(a, user_encoding))
107
101
 
108
102
 
109
103
def make_readonly(filename):
110
104
    """Make a filename read-only."""
111
105
    mod = os.lstat(filename).st_mode
112
106
    if not stat.S_ISLNK(mod):
113
 
        mod = mod & 0777555
114
 
        os.chmod(filename, mod)
 
107
        mod = mod & 0o777555
 
108
        chmod_if_possible(filename, mod)
115
109
 
116
110
 
117
111
def make_writable(filename):
118
112
    mod = os.lstat(filename).st_mode
119
113
    if not stat.S_ISLNK(mod):
120
 
        mod = mod | 0200
121
 
        os.chmod(filename, mod)
 
114
        mod = mod | 0o200
 
115
        chmod_if_possible(filename, mod)
 
116
 
 
117
 
 
118
def chmod_if_possible(filename, mode):
 
119
    # Set file mode if that can be safely done.
 
120
    # Sometimes even on unix the filesystem won't allow it - see
 
121
    # https://bugs.launchpad.net/bzr/+bug/606537
 
122
    try:
 
123
        # It is probably faster to just do the chmod, rather than
 
124
        # doing a stat, and then trying to compare
 
125
        os.chmod(filename, mode)
 
126
    except (IOError, OSError) as e:
 
127
        # Permission/access denied seems to commonly happen on smbfs; there's
 
128
        # probably no point warning about it.
 
129
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
130
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
131
            trace.mutter("ignore error on chmod of %r: %r" % (
 
132
                filename, e))
 
133
            return
 
134
        raise
122
135
 
123
136
 
124
137
def minimum_path_selection(paths):
199
212
            stat = getattr(os, 'lstat', os.stat)
200
213
            stat(f)
201
214
            return True
202
 
        except OSError, e:
 
215
        except OSError as e:
203
216
            if e.errno == errno.ENOENT:
204
217
                return False;
205
218
            else:
206
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
219
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
207
220
 
208
221
 
209
222
def fancy_rename(old, new, rename_func, unlink_func):
233
246
    file_existed = False
234
247
    try:
235
248
        rename_func(new, tmp_name)
236
 
    except (errors.NoSuchFile,), e:
 
249
    except (errors.NoSuchFile,) as e:
237
250
        pass
238
 
    except IOError, e:
 
251
    except IOError as e:
239
252
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
240
253
        # function raises an IOError with errno is None when a rename fails.
241
254
        # This then gets caught here.
242
255
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
243
256
            raise
244
 
    except Exception, e:
 
257
    except Exception as e:
245
258
        if (getattr(e, 'errno', None) is None
246
259
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
247
260
            raise
248
261
    else:
249
262
        file_existed = True
250
263
 
251
 
    failure_exc = None
252
264
    success = False
253
265
    try:
254
 
        try:
255
 
            # This may throw an exception, in which case success will
256
 
            # not be set.
257
 
            rename_func(old, new)
258
 
            success = True
259
 
        except (IOError, OSError), e:
260
 
            # source and target may be aliases of each other (e.g. on a
261
 
            # case-insensitive filesystem), so we may have accidentally renamed
262
 
            # source by when we tried to rename target
263
 
            failure_exc = sys.exc_info()
264
 
            if (file_existed and e.errno in (None, errno.ENOENT)
265
 
                and old.lower() == new.lower()):
266
 
                # source and target are the same file on a case-insensitive
267
 
                # filesystem, so we don't generate an exception
268
 
                failure_exc = None
 
266
        # This may throw an exception, in which case success will
 
267
        # not be set.
 
268
        rename_func(old, new)
 
269
        success = True
 
270
    except (IOError, OSError) as e:
 
271
        # source and target may be aliases of each other (e.g. on a
 
272
        # case-insensitive filesystem), so we may have accidentally renamed
 
273
        # source by when we tried to rename target
 
274
        if (file_existed and e.errno in (None, errno.ENOENT)
 
275
            and old.lower() == new.lower()):
 
276
            # source and target are the same file on a case-insensitive
 
277
            # filesystem, so we don't generate an exception
 
278
            pass
 
279
        else:
 
280
            raise
269
281
    finally:
270
282
        if file_existed:
271
283
            # If the file used to exist, rename it back into place
274
286
                unlink_func(tmp_name)
275
287
            else:
276
288
                rename_func(tmp_name, new)
277
 
    if failure_exc is not None:
278
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
279
289
 
280
290
 
281
291
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
282
292
# choke on a Unicode string containing a relative path if
283
293
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
294
# string.
285
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
286
295
def _posix_abspath(path):
287
296
    # jam 20060426 rather than encoding to fsencoding
288
297
    # copy posixpath.abspath, but use os.getcwdu instead
289
298
    if not posixpath.isabs(path):
290
299
        path = posixpath.join(getcwd(), path)
291
 
    return posixpath.normpath(path)
 
300
    return _posix_normpath(path)
292
301
 
293
302
 
294
303
def _posix_realpath(path):
295
304
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
296
305
 
297
306
 
 
307
def _posix_normpath(path):
 
308
    path = posixpath.normpath(path)
 
309
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
310
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
311
    # leading slashes must not be simplified to one, and only if there are 3 or
 
312
    # more should they be simplified as one. So we treat the leading 2 slashes
 
313
    # as a special case here by simply removing the first slash, as we consider
 
314
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
315
    # This is not a paranoid precaution, as we notably get paths like this when
 
316
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
317
    if path.startswith('//'):
 
318
        path = path[1:]
 
319
    return path
 
320
 
 
321
 
 
322
def _posix_path_from_environ(key):
 
323
    """Get unicode path from `key` in environment or None if not present
 
324
 
 
325
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
326
    so a path that raises BadFilenameEncoding here may still be accessible.
 
327
    """
 
328
    val = os.environ.get(key, None)
 
329
    if PY3 or val is None:
 
330
        return val
 
331
    try:
 
332
        return val.decode(_fs_enc)
 
333
    except UnicodeDecodeError:
 
334
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
335
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
336
 
 
337
 
 
338
def _posix_get_home_dir():
 
339
    """Get the home directory of the current user as a unicode path"""
 
340
    path = posixpath.expanduser("~")
 
341
    try:
 
342
        return path.decode(_fs_enc)
 
343
    except AttributeError:
 
344
        return path
 
345
    except UnicodeDecodeError:
 
346
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
347
 
 
348
 
 
349
def _posix_getuser_unicode():
 
350
    """Get username from environment or password database as unicode"""
 
351
    name = getpass.getuser()
 
352
    user_encoding = get_user_encoding()
 
353
    try:
 
354
        return name.decode(user_encoding)
 
355
    except UnicodeDecodeError:
 
356
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
357
            "application locale." % (name, user_encoding))
 
358
 
 
359
 
298
360
def _win32_fixdrive(path):
299
361
    """Force drive letters to be consistent.
300
362
 
304
366
    running python.exe under cmd.exe return capital C:\\
305
367
    running win32 python inside a cygwin shell returns lowercase c:\\
306
368
    """
307
 
    drive, path = _nt_splitdrive(path)
 
369
    drive, path = ntpath.splitdrive(path)
308
370
    return drive.upper() + path
309
371
 
310
372
 
311
373
def _win32_abspath(path):
312
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
313
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
374
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
375
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
314
376
 
315
377
 
316
378
def _win98_abspath(path):
327
389
    #   /path       => C:/path
328
390
    path = unicode(path)
329
391
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
 
392
    drive = ntpath.splitdrive(path)[0]
331
393
    if drive == '' and path[:2] not in('//','\\\\'):
332
 
        cwd = os.getcwdu()
 
394
        cwd = _getcwd()
333
395
        # we cannot simply os.path.join cwd and path
334
396
        # because os.path.join('C:','/path') produce '/path'
335
397
        # and this is incorrect
336
398
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
 
399
            cwd = ntpath.splitdrive(cwd)[0]
338
400
            path = path[1:]
339
401
        path = cwd + '\\' + path
340
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
402
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
403
 
342
404
 
343
405
def _win32_realpath(path):
344
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
345
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
406
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
407
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
346
408
 
347
409
 
348
410
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
411
    return ntpath.join(*args).replace('\\', '/')
350
412
 
351
413
 
352
414
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
415
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
416
 
355
417
 
356
418
def _win32_getcwd():
357
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
419
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
358
420
 
359
421
 
360
422
def _win32_mkdtemp(*args, **kwargs):
361
423
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
424
 
363
425
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
426
def _win32_rename(old, new):
373
427
    """We expect to be able to atomically replace 'new' with old.
374
428
 
376
430
    and then deleted.
377
431
    """
378
432
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
380
 
    except OSError, e:
 
433
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
434
    except OSError as e:
381
435
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
436
            # If we try to rename a non-existant file onto cwd, we get
383
437
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
387
441
        raise
388
442
 
389
443
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
444
def _mac_getcwd():
401
 
    return unicodedata.normalize('NFC', os.getcwdu())
402
 
 
 
445
    return unicodedata.normalize('NFC', _getcwd())
 
446
 
 
447
 
 
448
def _rename_wrap_exception(rename_func):
 
449
    """Adds extra information to any exceptions that come from rename().
 
450
 
 
451
    The exception has an updated message and 'old_filename' and 'new_filename'
 
452
    attributes.
 
453
    """
 
454
 
 
455
    def _rename_wrapper(old, new):
 
456
        try:
 
457
            rename_func(old, new)
 
458
        except OSError as e:
 
459
            detailed_error = OSError(e.errno, e.strerror +
 
460
                                " [occurred when renaming '%s' to '%s']" %
 
461
                                (old, new))
 
462
            detailed_error.old_filename = old
 
463
            detailed_error.new_filename = new
 
464
            raise detailed_error
 
465
 
 
466
    return _rename_wrapper
 
467
 
 
468
 
 
469
if sys.version_info > (3,):
 
470
    _getcwd = os.getcwd
 
471
else:
 
472
    _getcwd = os.getcwdu
 
473
 
 
474
 
 
475
# Default rename wraps os.rename()
 
476
rename = _rename_wrap_exception(os.rename)
403
477
 
404
478
# Default is to just use the python builtins, but these can be rebound on
405
479
# particular platforms.
406
480
abspath = _posix_abspath
407
481
realpath = _posix_realpath
408
482
pathjoin = os.path.join
409
 
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
 
getcwd = os.getcwdu
 
483
normpath = _posix_normpath
 
484
path_from_environ = _posix_path_from_environ
 
485
_get_home_dir = _posix_get_home_dir
 
486
getuser_unicode = _posix_getuser_unicode
 
487
getcwd = _getcwd
412
488
dirname = os.path.dirname
413
489
basename = os.path.basename
414
490
split = os.path.split
415
491
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
492
# These were already lazily imported into local scope
417
493
# mkdtemp = tempfile.mkdtemp
418
494
# rmtree = shutil.rmtree
 
495
lstat = os.lstat
 
496
fstat = os.fstat
 
497
 
 
498
def wrap_stat(st):
 
499
    return st
 
500
 
419
501
 
420
502
MIN_ABS_PATHLENGTH = 1
421
503
 
430
512
    normpath = _win32_normpath
431
513
    getcwd = _win32_getcwd
432
514
    mkdtemp = _win32_mkdtemp
433
 
    rename = _win32_rename
 
515
    rename = _rename_wrap_exception(_win32_rename)
 
516
    try:
 
517
        from . import _walkdirs_win32
 
518
    except ImportError:
 
519
        pass
 
520
    else:
 
521
        lstat = _walkdirs_win32.lstat
 
522
        fstat = _walkdirs_win32.fstat
 
523
        wrap_stat = _walkdirs_win32.wrap_stat
434
524
 
435
525
    MIN_ABS_PATHLENGTH = 3
436
526
 
454
544
    f = win32utils.get_unicode_argv     # special function or None
455
545
    if f is not None:
456
546
        get_unicode_argv = f
 
547
    path_from_environ = win32utils.get_environ_unicode
 
548
    _get_home_dir = win32utils.get_home_location
 
549
    getuser_unicode = win32utils.get_user_name
457
550
 
458
551
elif sys.platform == 'darwin':
459
552
    getcwd = _mac_getcwd
460
553
 
461
554
 
462
 
def get_terminal_encoding():
 
555
def get_terminal_encoding(trace=False):
463
556
    """Find the best encoding for printing to the screen.
464
557
 
465
558
    This attempts to check both sys.stdout and sys.stdin to see
471
564
 
472
565
    On my standard US Windows XP, the preferred encoding is
473
566
    cp1252, but the console is cp437
 
567
 
 
568
    :param trace: If True trace the selected encoding via mutter().
474
569
    """
475
 
    from bzrlib.trace import mutter
 
570
    from .trace import mutter
476
571
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
572
    if not output_encoding:
478
573
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
574
        if not input_encoding:
480
575
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
576
            if trace:
 
577
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
578
                   output_encoding)
483
579
        else:
484
580
            output_encoding = input_encoding
485
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
581
            if trace:
 
582
                mutter('encoding stdout as sys.stdin encoding %r',
 
583
                    output_encoding)
486
584
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
585
        if trace:
 
586
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
587
    if output_encoding == 'cp0':
489
588
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
589
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
590
        if trace:
 
591
            mutter('cp0 is invalid encoding.'
492
592
               ' encoding stdout as osutils.get_user_encoding() %r',
493
593
               output_encoding)
494
594
    # check encoding
495
595
    try:
496
596
        codecs.lookup(output_encoding)
497
597
    except LookupError:
498
 
        sys.stderr.write('bzr: warning:'
 
598
        sys.stderr.write('brz: warning:'
499
599
                         ' unknown terminal encoding %s.\n'
500
600
                         '  Using encoding %s instead.\n'
501
601
                         % (output_encoding, get_user_encoding())
520
620
def isdir(f):
521
621
    """True if f is an accessible directory."""
522
622
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
623
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
624
    except OSError:
525
625
        return False
526
626
 
528
628
def isfile(f):
529
629
    """True if f is a regular file."""
530
630
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
631
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
632
    except OSError:
533
633
        return False
534
634
 
535
635
def islink(f):
536
636
    """True if f is a symlink."""
537
637
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
638
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
639
    except OSError:
540
640
        return False
541
641
 
638
738
    # drives).
639
739
    if not segment_size:
640
740
        segment_size = 5242880 # 5MB
641
 
    segments = range(len(bytes) / segment_size + 1)
 
741
    offsets = range(0, len(bytes), segment_size)
 
742
    view = memoryview(bytes)
642
743
    write = file_handle.write
643
 
    for segment_index in segments:
644
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
645
 
        write(segment)
 
744
    for offset in offsets:
 
745
        write(view[offset:offset+segment_size])
646
746
 
647
747
 
648
748
def file_iterator(input_file, readsize=32768):
703
803
def sha_strings(strings, _factory=sha):
704
804
    """Return the sha-1 of concatenation of strings"""
705
805
    s = _factory()
706
 
    map(s.update, strings)
 
806
    for string in strings:
 
807
        s.update(string)
707
808
    return s.hexdigest()
708
809
 
709
810
 
729
830
            return True
730
831
 
731
832
 
 
833
def gmtime(seconds=None):
 
834
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
835
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
836
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
837
    """
 
838
    if seconds is None:
 
839
        seconds = time.time()
 
840
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
841
 
 
842
 
732
843
def local_time_offset(t=None):
733
844
    """Return offset of local zone from GMT, either at present or at time t."""
734
845
    if t is None:
774
885
    """
775
886
    if offset is None:
776
887
        offset = 0
777
 
    tt = time.gmtime(t + offset)
 
888
    tt = gmtime(t + offset)
778
889
    date_fmt = _default_format_by_weekday_num[tt[6]]
779
890
    date_str = time.strftime(date_fmt, tt)
780
891
    offset_str = _cache.get(offset, None)
799
910
    (date_fmt, tt, offset_str) = \
800
911
               _format_date(t, offset, timezone, date_fmt, show_offset)
801
912
    date_str = time.strftime(date_fmt, tt)
802
 
    if not isinstance(date_str, unicode):
 
913
    if not isinstance(date_str, text_type):
803
914
        date_str = date_str.decode(get_user_encoding(), 'replace')
804
915
    return date_str + offset_str
805
916
 
806
917
 
807
918
def _format_date(t, offset, timezone, date_fmt, show_offset):
808
919
    if timezone == 'utc':
809
 
        tt = time.gmtime(t)
 
920
        tt = gmtime(t)
810
921
        offset = 0
811
922
    elif timezone == 'original':
812
923
        if offset is None:
813
924
            offset = 0
814
 
        tt = time.gmtime(t + offset)
 
925
        tt = gmtime(t + offset)
815
926
    elif timezone == 'local':
816
927
        tt = time.localtime(t)
817
928
        offset = local_time_offset(t)
827
938
 
828
939
 
829
940
def compact_date(when):
830
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
941
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
831
942
 
832
943
 
833
944
def format_delta(delta):
881
992
 
882
993
def filesize(f):
883
994
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
885
 
 
886
 
 
887
 
# Define rand_bytes based on platform.
888
 
try:
889
 
    # Python 2.4 and later have os.urandom,
890
 
    # but it doesn't work on some arches
891
 
    os.urandom(1)
892
 
    rand_bytes = os.urandom
893
 
except (NotImplementedError, AttributeError):
894
 
    # If python doesn't have os.urandom, or it doesn't work,
895
 
    # then try to first pull random data from /dev/urandom
 
995
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
996
 
 
997
 
 
998
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
999
# override if it doesn't work. Avoid checking on windows where there is
 
1000
# significant initialisation cost that can be avoided for some bzr calls.
 
1001
 
 
1002
rand_bytes = os.urandom
 
1003
 
 
1004
if rand_bytes.__module__ != "nt":
896
1005
    try:
897
 
        rand_bytes = file('/dev/urandom', 'rb').read
898
 
    # Otherwise, use this hack as a last resort
899
 
    except (IOError, OSError):
 
1006
        rand_bytes(1)
 
1007
    except NotImplementedError:
900
1008
        # not well seeded, but better than nothing
901
1009
        def rand_bytes(n):
902
1010
            import random
932
1040
    rps = []
933
1041
    for f in ps:
934
1042
        if f == '..':
935
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1043
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
936
1044
        elif (f == '.') or (f == ''):
937
1045
            pass
938
1046
        else:
943
1051
def joinpath(p):
944
1052
    for f in p:
945
1053
        if (f == '..') or (f is None) or (f == ''):
946
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1054
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
947
1055
    return pathjoin(*p)
948
1056
 
949
1057
 
950
1058
def parent_directories(filename):
951
1059
    """Return the list of parent directories, deepest first.
952
 
    
 
1060
 
953
1061
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
1062
    """
955
1063
    parents = []
971
1079
    implementation should be loaded instead::
972
1080
 
973
1081
    >>> try:
974
 
    >>>     import bzrlib._fictional_extension_pyx
 
1082
    >>>     import breezy._fictional_extension_pyx
975
1083
    >>> except ImportError, e:
976
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
977
 
    >>>     import bzrlib._fictional_extension_py
 
1084
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1085
    >>>     import breezy._fictional_extension_py
978
1086
    """
979
1087
    # NB: This docstring is just an example, not a doctest, because doctest
980
1088
    # currently can't cope with the use of lazy imports in this namespace --
981
1089
    # mbp 20090729
982
 
    
 
1090
 
983
1091
    # This currently doesn't report the failure at the time it occurs, because
984
1092
    # they tend to happen very early in startup when we can't check config
985
1093
    # files etc, and also we want to report all failures but not spam the user
986
1094
    # with 10 warnings.
987
 
    from bzrlib import trace
988
1095
    exception_str = str(exception)
989
1096
    if exception_str not in _extension_load_failures:
990
1097
        trace.mutter("failed to load compiled extension: %s" % exception_str)
994
1101
def report_extension_load_failures():
995
1102
    if not _extension_load_failures:
996
1103
        return
997
 
    from bzrlib.config import GlobalConfig
998
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1104
    if config.GlobalStack().get('ignore_missing_extensions'):
999
1105
        return
1000
1106
    # the warnings framework should by default show this only once
1001
 
    from bzrlib.trace import warning
 
1107
    from .trace import warning
1002
1108
    warning(
1003
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1109
        "brz: warning: some compiled extensions could not be loaded; "
1004
1110
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1005
1111
    # we no longer show the specific missing extensions here, because it makes
1006
1112
    # the message too long and scary - see
1008
1114
 
1009
1115
 
1010
1116
try:
1011
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1012
 
except ImportError, e:
 
1117
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1118
except ImportError as e:
1013
1119
    failed_to_load_extension(e)
1014
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1120
    from ._chunks_to_lines_py import chunks_to_lines
1015
1121
 
1016
1122
 
1017
1123
def split_lines(s):
1048
1154
        return
1049
1155
    try:
1050
1156
        os.link(src, dest)
1051
 
    except (OSError, IOError), e:
 
1157
    except (OSError, IOError) as e:
1052
1158
        if e.errno != errno.EXDEV:
1053
1159
            raise
1054
1160
        shutil.copyfile(src, dest)
1055
1161
 
1056
1162
 
1057
1163
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1164
    """Delete a file, symlink or directory.
 
1165
 
1060
1166
    Will delete even if readonly.
1061
1167
    """
1062
1168
    try:
1063
1169
       _delete_file_or_dir(path)
1064
 
    except (OSError, IOError), e:
 
1170
    except (OSError, IOError) as e:
1065
1171
        if e.errno in (errno.EPERM, errno.EACCES):
1066
1172
            # make writable and try again
1067
1173
            try:
1163
1269
 
1164
1270
    if len(base) < MIN_ABS_PATHLENGTH:
1165
1271
        # must have space for e.g. a drive letter
1166
 
        raise ValueError('%r is too short to calculate a relative path'
 
1272
        raise ValueError(gettext('%r is too short to calculate a relative path')
1167
1273
            % (base,))
1168
1274
 
1169
1275
    rp = abspath(path)
1251
1357
    # but for now, we haven't optimized...
1252
1358
    return [canonical_relpath(base, p) for p in paths]
1253
1359
 
 
1360
 
 
1361
def decode_filename(filename):
 
1362
    """Decode the filename using the filesystem encoding
 
1363
 
 
1364
    If it is unicode, it is returned.
 
1365
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1366
    fails, a errors.BadFilenameEncoding exception is raised.
 
1367
    """
 
1368
    if isinstance(filename, text_type):
 
1369
        return filename
 
1370
    try:
 
1371
        return filename.decode(_fs_enc)
 
1372
    except UnicodeDecodeError:
 
1373
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1374
 
 
1375
 
1254
1376
def safe_unicode(unicode_or_utf8_string):
1255
1377
    """Coerce unicode_or_utf8_string into unicode.
1256
1378
 
1258
1380
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1259
1381
    wrapped in a BzrBadParameterNotUnicode exception.
1260
1382
    """
1261
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1383
    if isinstance(unicode_or_utf8_string, text_type):
1262
1384
        return unicode_or_utf8_string
1263
1385
    try:
1264
1386
        return unicode_or_utf8_string.decode('utf8')
1285
1407
    return unicode_or_utf8_string.encode('utf-8')
1286
1408
 
1287
1409
 
1288
 
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1289
 
                        ' Revision id generators should be creating utf8'
1290
 
                        ' revision ids.')
1291
 
 
1292
 
 
1293
 
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
1410
def safe_revision_id(unicode_or_utf8_string):
1294
1411
    """Revision ids should now be utf8, but at one point they were unicode.
1295
1412
 
1296
1413
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1297
1414
        utf8 or None).
1298
 
    :param warn: Functions that are sanitizing user data can set warn=False
1299
1415
    :return: None or a utf8 revision id.
1300
1416
    """
1301
1417
    if (unicode_or_utf8_string is None
1302
1418
        or unicode_or_utf8_string.__class__ == str):
1303
1419
        return unicode_or_utf8_string
1304
 
    if warn:
1305
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1306
 
                               stacklevel=2)
1307
 
    return cache_utf8.encode(unicode_or_utf8_string)
1308
 
 
1309
 
 
1310
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1311
 
                    ' generators should be creating utf8 file ids.')
1312
 
 
1313
 
 
1314
 
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1420
    raise TypeError('Unicode revision ids are no longer supported. '
 
1421
                    'Revision id generators should be creating utf8 revision '
 
1422
                    'ids.')
 
1423
 
 
1424
 
 
1425
def safe_file_id(unicode_or_utf8_string):
1315
1426
    """File ids should now be utf8, but at one point they were unicode.
1316
1427
 
1317
1428
    This is the same as safe_utf8, except it uses the cached encode functions
1319
1430
 
1320
1431
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1321
1432
        utf8 or None).
1322
 
    :param warn: Functions that are sanitizing user data can set warn=False
1323
1433
    :return: None or a utf8 file id.
1324
1434
    """
1325
1435
    if (unicode_or_utf8_string is None
1326
1436
        or unicode_or_utf8_string.__class__ == str):
1327
1437
        return unicode_or_utf8_string
1328
 
    if warn:
1329
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1330
 
                               stacklevel=2)
1331
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
1438
    raise TypeError('Unicode file ids are no longer supported. '
 
1439
                    'File id generators should be creating utf8 file ids.')
1332
1440
 
1333
1441
 
1334
1442
_platform_normalizes_filenames = False
1339
1447
def normalizes_filenames():
1340
1448
    """Return True if this platform normalizes unicode filenames.
1341
1449
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1450
    Only Mac OSX.
1343
1451
    """
1344
1452
    return _platform_normalizes_filenames
1345
1453
 
1350
1458
    On platforms where the system normalizes filenames (Mac OSX),
1351
1459
    you can access a file by any path which will normalize correctly.
1352
1460
    On platforms where the system does not normalize filenames
1353
 
    (Windows, Linux), you have to access a file by its exact path.
 
1461
    (everything else), you have to access a file by its exact path.
1354
1462
 
1355
1463
    Internally, bzr only supports NFC normalization, since that is
1356
1464
    the standard for XML documents.
1418
1526
terminal_width() returns None.
1419
1527
"""
1420
1528
 
 
1529
# Keep some state so that terminal_width can detect if _terminal_size has
 
1530
# returned a different size since the process started.  See docstring and
 
1531
# comments of terminal_width for details.
 
1532
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1533
_terminal_size_state = 'no_data'
 
1534
_first_terminal_size = None
1421
1535
 
1422
1536
def terminal_width():
1423
1537
    """Return terminal width.
1425
1539
    None is returned if the width can't established precisely.
1426
1540
 
1427
1541
    The rules are:
1428
 
    - if BZR_COLUMNS is set, returns its value
 
1542
    - if BRZ_COLUMNS is set, returns its value
1429
1543
    - if there is no controlling terminal, returns None
 
1544
    - query the OS, if the queried size has changed since the last query,
 
1545
      return its value,
1430
1546
    - if COLUMNS is set, returns its value,
 
1547
    - if the OS has a value (even though it's never changed), return its value.
1431
1548
 
1432
1549
    From there, we need to query the OS to get the size of the controlling
1433
1550
    terminal.
1434
1551
 
1435
 
    Unices:
 
1552
    On Unices we query the OS by:
1436
1553
    - get termios.TIOCGWINSZ
1437
1554
    - if an error occurs or a negative value is obtained, returns None
1438
1555
 
1439
 
    Windows:
1440
 
    
 
1556
    On Windows we query the OS by:
1441
1557
    - win32utils.get_console_size() decides,
1442
1558
    - returns None on error (provided default value)
1443
1559
    """
 
1560
    # Note to implementors: if changing the rules for determining the width,
 
1561
    # make sure you've considered the behaviour in these cases:
 
1562
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1563
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1564
    #    0,0.
 
1565
    #  - (add more interesting cases here, if you find any)
 
1566
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1567
    # but we don't want to register a signal handler because it is impossible
 
1568
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1569
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1570
    # time so we can notice if the reported size has changed, which should have
 
1571
    # a similar effect.
1444
1572
 
1445
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1573
    # If BRZ_COLUMNS is set, take it, user is always right
 
1574
    # Except if they specified 0 in which case, impose no limit here
1446
1575
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1576
        width = int(os.environ['BRZ_COLUMNS'])
1448
1577
    except (KeyError, ValueError):
1449
 
        pass
 
1578
        width = None
 
1579
    if width is not None:
 
1580
        if width > 0:
 
1581
            return width
 
1582
        else:
 
1583
            return None
1450
1584
 
1451
1585
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
1453
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1586
    if isatty is None or not isatty():
 
1587
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1454
1588
        return None
1455
1589
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1590
    # Query the OS
 
1591
    width, height = os_size = _terminal_size(None, None)
 
1592
    global _first_terminal_size, _terminal_size_state
 
1593
    if _terminal_size_state == 'no_data':
 
1594
        _first_terminal_size = os_size
 
1595
        _terminal_size_state = 'unchanged'
 
1596
    elif (_terminal_size_state == 'unchanged' and
 
1597
          _first_terminal_size != os_size):
 
1598
        _terminal_size_state = 'changed'
 
1599
 
 
1600
    # If the OS claims to know how wide the terminal is, and this value has
 
1601
    # ever changed, use that.
 
1602
    if _terminal_size_state == 'changed':
 
1603
        if width is not None and width > 0:
 
1604
            return width
 
1605
 
 
1606
    # If COLUMNS is set, use it.
1459
1607
    try:
1460
1608
        return int(os.environ['COLUMNS'])
1461
1609
    except (KeyError, ValueError):
1462
1610
        pass
1463
1611
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
 
1612
    # Finally, use an unchanged size from the OS, if we have one.
 
1613
    if _terminal_size_state == 'unchanged':
 
1614
        if width is not None and width > 0:
 
1615
            return width
1468
1616
 
1469
 
    return width
 
1617
    # The width could not be determined.
 
1618
    return None
1470
1619
 
1471
1620
 
1472
1621
def _win32_terminal_size(width, height):
1499
1648
    _terminal_size = _ioctl_terminal_size
1500
1649
 
1501
1650
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
1523
 
            pass
1524
 
        _registered_sigwinch = True
1525
 
 
1526
 
 
1527
1651
def supports_executable():
1528
1652
    return sys.platform != "win32"
1529
1653
 
1554
1678
        if orig_val is not None:
1555
1679
            del os.environ[env_variable]
1556
1680
    else:
1557
 
        if isinstance(value, unicode):
 
1681
        if not PY3 and isinstance(value, text_type):
1558
1682
            value = value.encode(get_user_encoding())
1559
1683
        os.environ[env_variable] = value
1560
1684
    return orig_val
1652
1776
        dirblock = []
1653
1777
        append = dirblock.append
1654
1778
        try:
1655
 
            names = sorted(_listdir(top))
1656
 
        except OSError, e:
 
1779
            names = sorted(map(decode_filename, _listdir(top)))
 
1780
        except OSError as e:
1657
1781
            if not _is_error_enotdir(e):
1658
1782
                raise
1659
1783
        else:
1712
1836
    """
1713
1837
    global _selected_dir_reader
1714
1838
    if _selected_dir_reader is None:
1715
 
        fs_encoding = _fs_enc.upper()
1716
1839
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1717
1840
            # Win98 doesn't have unicode apis like FindFirstFileW
1718
1841
            # TODO: We possibly could support Win98 by falling back to the
1720
1843
            #       but that gets a bit tricky, and requires custom compiling
1721
1844
            #       for win98 anyway.
1722
1845
            try:
1723
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1846
                from ._walkdirs_win32 import Win32ReadDir
1724
1847
                _selected_dir_reader = Win32ReadDir()
1725
1848
            except ImportError:
1726
1849
                pass
1727
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1728
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1850
        elif _fs_enc in ('utf-8', 'ascii'):
1729
1851
            try:
1730
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1852
                from ._readdir_pyx import UTF8DirReader
1731
1853
                _selected_dir_reader = UTF8DirReader()
1732
 
            except ImportError, e:
 
1854
            except ImportError as e:
1733
1855
                failed_to_load_extension(e)
1734
1856
                pass
1735
1857
 
1865
1987
    try:
1866
1988
        s = os.stat(src)
1867
1989
        chown(dst, s.st_uid, s.st_gid)
1868
 
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1990
    except OSError as e:
 
1991
        trace.warning(
 
1992
            'Unable to copy ownership from "%s" to "%s". '
 
1993
            'You may want to set it manually.', src, dst)
 
1994
        trace.log_exception_quietly()
1870
1995
 
1871
1996
 
1872
1997
def path_prefix_key(path):
1887
2012
_cached_user_encoding = None
1888
2013
 
1889
2014
 
1890
 
def get_user_encoding(use_cache=True):
 
2015
def get_user_encoding():
1891
2016
    """Find out what the preferred user encoding is.
1892
2017
 
1893
2018
    This is generally the encoding that is used for command line parameters
1894
2019
    and file contents. This may be different from the terminal encoding
1895
2020
    or the filesystem encoding.
1896
2021
 
1897
 
    :param  use_cache:  Enable cache for detected encoding.
1898
 
                        (This parameter is turned on by default,
1899
 
                        and required only for selftesting)
1900
 
 
1901
2022
    :return: A string defining the preferred user encoding
1902
2023
    """
1903
2024
    global _cached_user_encoding
1904
 
    if _cached_user_encoding is not None and use_cache:
 
2025
    if _cached_user_encoding is not None:
1905
2026
        return _cached_user_encoding
1906
2027
 
1907
 
    if sys.platform == 'darwin':
1908
 
        # python locale.getpreferredencoding() always return
1909
 
        # 'mac-roman' on darwin. That's a lie.
1910
 
        sys.platform = 'posix'
1911
 
        try:
1912
 
            if os.environ.get('LANG', None) is None:
1913
 
                # If LANG is not set, we end up with 'ascii', which is bad
1914
 
                # ('mac-roman' is more than ascii), so we set a default which
1915
 
                # will give us UTF-8 (which appears to work in all cases on
1916
 
                # OSX). Users are still free to override LANG of course, as
1917
 
                # long as it give us something meaningful. This work-around
1918
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1919
 
                # work with them too -- vila 20080908
1920
 
                os.environ['LANG'] = 'en_US.UTF-8'
1921
 
            import locale
1922
 
        finally:
1923
 
            sys.platform = 'darwin'
 
2028
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2029
        # Use the existing locale settings and call nl_langinfo directly
 
2030
        # rather than going through getpreferredencoding. This avoids
 
2031
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2032
        # possibility of the setlocale call throwing an error.
 
2033
        user_encoding = locale.nl_langinfo(locale.CODESET)
1924
2034
    else:
1925
 
        import locale
 
2035
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2036
        user_encoding = locale.getpreferredencoding(False)
1926
2037
 
1927
2038
    try:
1928
 
        user_encoding = locale.getpreferredencoding()
1929
 
    except locale.Error, e:
1930
 
        sys.stderr.write('bzr: warning: %s\n'
1931
 
                         '  Could not determine what text encoding to use.\n'
1932
 
                         '  This error usually means your Python interpreter\n'
1933
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1934
 
                         "  Continuing with ascii encoding.\n"
1935
 
                         % (e, os.environ.get('LANG')))
1936
 
        user_encoding = 'ascii'
1937
 
 
1938
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1939
 
    # treat that as ASCII, and not support printing unicode characters to the
1940
 
    # console.
1941
 
    #
1942
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1943
 
    if user_encoding in (None, 'cp0', ''):
1944
 
        user_encoding = 'ascii'
1945
 
    else:
1946
 
        # check encoding
1947
 
        try:
1948
 
            codecs.lookup(user_encoding)
1949
 
        except LookupError:
1950
 
            sys.stderr.write('bzr: warning:'
 
2039
        user_encoding = codecs.lookup(user_encoding).name
 
2040
    except LookupError:
 
2041
        if user_encoding not in ("", "cp0"):
 
2042
            sys.stderr.write('brz: warning:'
1951
2043
                             ' unknown encoding %s.'
1952
2044
                             ' Continuing with ascii encoding.\n'
1953
2045
                             % user_encoding
1954
2046
                            )
1955
 
            user_encoding = 'ascii'
1956
 
 
1957
 
    if use_cache:
1958
 
        _cached_user_encoding = user_encoding
1959
 
 
 
2047
        user_encoding = 'ascii'
 
2048
    else:
 
2049
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2050
        if user_encoding == 'ascii':
 
2051
            if sys.platform == 'darwin':
 
2052
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2053
                # encoding and previously had LANG set here if not present.
 
2054
                user_encoding = 'utf-8'
 
2055
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2056
            #                for some other posix platforms as well.
 
2057
 
 
2058
    _cached_user_encoding = user_encoding
1960
2059
    return user_encoding
1961
2060
 
1962
2061
 
 
2062
def get_diff_header_encoding():
 
2063
    return get_terminal_encoding()
 
2064
 
 
2065
 
1963
2066
def get_host_name():
1964
2067
    """Return the current unicode host name.
1965
2068
 
1967
2070
    behaves inconsistently on different platforms.
1968
2071
    """
1969
2072
    if sys.platform == "win32":
1970
 
        import win32utils
1971
2073
        return win32utils.get_host_name()
1972
2074
    else:
1973
2075
        import socket
1980
2082
# data at once.
1981
2083
MAX_SOCKET_CHUNK = 64 * 1024
1982
2084
 
 
2085
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2086
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2087
    _eno = getattr(errno, _eno, None)
 
2088
    if _eno is not None:
 
2089
        _end_of_stream_errors.append(_eno)
 
2090
del _eno
 
2091
 
 
2092
 
1983
2093
def read_bytes_from_socket(sock, report_activity=None,
1984
2094
        max_read_size=MAX_SOCKET_CHUNK):
1985
2095
    """Read up to max_read_size of bytes from sock and notify of progress.
1988
2098
    empty string rather than raise an error), and repeats the recv if
1989
2099
    interrupted by a signal.
1990
2100
    """
1991
 
    while 1:
 
2101
    while True:
1992
2102
        try:
1993
2103
            bytes = sock.recv(max_read_size)
1994
 
        except socket.error, e:
 
2104
        except socket.error as e:
1995
2105
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2106
            if eno in _end_of_stream_errors:
1997
2107
                # The connection was closed by the other side.  Callers expect
1998
2108
                # an empty string to signal end-of-stream.
1999
2109
                return ""
2028
2138
 
2029
2139
def send_all(sock, bytes, report_activity=None):
2030
2140
    """Send all bytes on a socket.
2031
 
 
 
2141
 
2032
2142
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2143
    some platforms, and catches EINTR which may be thrown if the send is
2034
2144
    interrupted by a signal.
2035
2145
 
2036
2146
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2147
    and provides activity reporting.
2038
 
 
 
2148
 
2039
2149
    :param report_activity: Call this as bytes are read, see
2040
2150
        Transport._report_activity
2041
2151
    """
2042
2152
    sent_total = 0
2043
2153
    byte_count = len(bytes)
 
2154
    view = memoryview(bytes)
2044
2155
    while sent_total < byte_count:
2045
2156
        try:
2046
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2047
 
        except socket.error, e:
 
2157
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
 
2158
        except (socket.error, IOError) as e:
 
2159
            if e.args[0] in _end_of_stream_errors:
 
2160
                raise errors.ConnectionReset(
 
2161
                    "Error trying to write to socket", e)
2048
2162
            if e.args[0] != errno.EINTR:
2049
2163
                raise
2050
2164
        else:
 
2165
            if sent == 0:
 
2166
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2167
                                             % (sock,))
2051
2168
            sent_total += sent
2052
 
            report_activity(sent, 'write')
 
2169
            if report_activity is not None:
 
2170
                report_activity(sent, 'write')
 
2171
 
 
2172
 
 
2173
def connect_socket(address):
 
2174
    # Slight variation of the socket.create_connection() function (provided by
 
2175
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2176
    # provide it for previous python versions. Also, we don't use the timeout
 
2177
    # parameter (provided by the python implementation) so we don't implement
 
2178
    # it either).
 
2179
    err = socket.error('getaddrinfo returns an empty list')
 
2180
    host, port = address
 
2181
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2182
        af, socktype, proto, canonname, sa = res
 
2183
        sock = None
 
2184
        try:
 
2185
            sock = socket.socket(af, socktype, proto)
 
2186
            sock.connect(sa)
 
2187
            return sock
 
2188
 
 
2189
        except socket.error as err:
 
2190
            # 'err' is now the most recent error
 
2191
            if sock is not None:
 
2192
                sock.close()
 
2193
    raise err
2053
2194
 
2054
2195
 
2055
2196
def dereference_path(path):
2074
2215
def resource_string(package, resource_name):
2075
2216
    """Load a resource from a package and return it as a string.
2076
2217
 
2077
 
    Note: Only packages that start with bzrlib are currently supported.
 
2218
    Note: Only packages that start with breezy are currently supported.
2078
2219
 
2079
2220
    This is designed to be a lightweight implementation of resource
2080
2221
    loading in a way which is API compatible with the same API from
2083
2224
    If and when pkg_resources becomes a standard library, this routine
2084
2225
    can delegate to it.
2085
2226
    """
2086
 
    # Check package name is within bzrlib
2087
 
    if package == "bzrlib":
 
2227
    # Check package name is within breezy
 
2228
    if package == "breezy":
2088
2229
        resource_relpath = resource_name
2089
 
    elif package.startswith("bzrlib."):
2090
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2230
    elif package.startswith("breezy."):
 
2231
        package = package[len("breezy."):].replace('.', os.sep)
2091
2232
        resource_relpath = pathjoin(package, resource_name)
2092
2233
    else:
2093
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2234
        raise errors.BzrError('resource package %s not in breezy' % package)
2094
2235
 
2095
2236
    # Map the resource to a file and read its contents
2096
 
    base = dirname(bzrlib.__file__)
 
2237
    base = dirname(breezy.__file__)
2097
2238
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2239
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2240
    f = file(pathjoin(base, resource_relpath), "rU")
 
2241
    try:
 
2242
        return f.read()
 
2243
    finally:
 
2244
        f.close()
2102
2245
 
2103
2246
def file_kind_from_stat_mode_thunk(mode):
2104
2247
    global file_kind_from_stat_mode
2105
2248
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2106
2249
        try:
2107
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2250
            from ._readdir_pyx import UTF8DirReader
2108
2251
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2109
 
        except ImportError, e:
 
2252
        except ImportError as e:
2110
2253
            # This is one time where we won't warn that an extension failed to
2111
2254
            # load. The extension is never available on Windows anyway.
2112
 
            from bzrlib._readdir_py import (
 
2255
            from ._readdir_py import (
2113
2256
                _kind_from_mode as file_kind_from_stat_mode
2114
2257
                )
2115
2258
    return file_kind_from_stat_mode(mode)
2116
2259
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2117
2260
 
2118
 
 
2119
 
def file_kind(f, _lstat=os.lstat):
 
2261
def file_stat(f, _lstat=os.lstat):
2120
2262
    try:
2121
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2122
 
    except OSError, e:
 
2263
        # XXX cache?
 
2264
        return _lstat(f)
 
2265
    except OSError as e:
2123
2266
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2124
2267
            raise errors.NoSuchFile(f)
2125
2268
        raise
2126
2269
 
 
2270
def file_kind(f, _lstat=os.lstat):
 
2271
    stat_value = file_stat(f, _lstat)
 
2272
    return file_kind_from_stat_mode(stat_value.st_mode)
2127
2273
 
2128
2274
def until_no_eintr(f, *a, **kw):
2129
2275
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2276
 
2131
2277
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2278
    if EINTR does occur.  This is typically only true for low-level operations
2133
2279
    like os.read.  If in any doubt, don't use this.
2135
2281
    Keep in mind that this is not a complete solution to EINTR.  There is
2136
2282
    probably code in the Python standard library and other dependencies that
2137
2283
    may encounter EINTR if a signal arrives (and there is signal handler for
2138
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2284
    that signal).  So this function can reduce the impact for IO that breezy
2139
2285
    directly controls, but it is not a complete solution.
2140
2286
    """
2141
2287
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2142
2288
    while True:
2143
2289
        try:
2144
2290
            return f(*a, **kw)
2145
 
        except (IOError, OSError), e:
 
2291
        except (IOError, OSError) as e:
2146
2292
            if e.errno == errno.EINTR:
2147
2293
                continue
2148
2294
            raise
2149
2295
 
2150
2296
 
2151
 
def re_compile_checked(re_string, flags=0, where=""):
2152
 
    """Return a compiled re, or raise a sensible error.
2153
 
 
2154
 
    This should only be used when compiling user-supplied REs.
2155
 
 
2156
 
    :param re_string: Text form of regular expression.
2157
 
    :param flags: eg re.IGNORECASE
2158
 
    :param where: Message explaining to the user the context where
2159
 
        it occurred, eg 'log search filter'.
2160
 
    """
2161
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
2162
 
    try:
2163
 
        re_obj = re.compile(re_string, flags)
2164
 
        re_obj.search("")
2165
 
        return re_obj
2166
 
    except re.error, e:
2167
 
        if where:
2168
 
            where = ' in ' + where
2169
 
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
2172
 
 
2173
 
 
2174
2297
if sys.platform == "win32":
2175
 
    import msvcrt
2176
2298
    def getchar():
 
2299
        import msvcrt
2177
2300
        return msvcrt.getch()
2178
2301
else:
2179
 
    import tty
2180
 
    import termios
2181
2302
    def getchar():
 
2303
        import tty
 
2304
        import termios
2182
2305
        fd = sys.stdin.fileno()
2183
2306
        settings = termios.tcgetattr(fd)
2184
2307
        try:
2188
2311
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2312
        return ch
2190
2313
 
2191
 
 
2192
 
if sys.platform == 'linux2':
 
2314
if sys.platform.startswith('linux'):
2193
2315
    def _local_concurrency():
2194
 
        concurrency = None
2195
 
        prefix = 'processor'
2196
 
        for line in file('/proc/cpuinfo', 'rb'):
2197
 
            if line.startswith(prefix):
2198
 
                concurrency = int(line[line.find(':')+1:]) + 1
2199
 
        return concurrency
 
2316
        try:
 
2317
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2318
        except (ValueError, OSError, AttributeError):
 
2319
            return None
2200
2320
elif sys.platform == 'darwin':
2201
2321
    def _local_concurrency():
2202
2322
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2323
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2324
elif "bsd" in sys.platform:
2205
2325
    def _local_concurrency():
2206
2326
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2327
                                stdout=subprocess.PIPE).communicate()[0]
2232
2352
    if _cached_local_concurrency is not None and use_cache:
2233
2353
        return _cached_local_concurrency
2234
2354
 
2235
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2355
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2236
2356
    if concurrency is None:
2237
2357
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            pass
 
2358
            import multiprocessing
 
2359
            concurrency = multiprocessing.cpu_count()
 
2360
        except (ImportError, NotImplementedError):
 
2361
            # multiprocessing is only available on Python >= 2.6
 
2362
            # and multiprocessing.cpu_count() isn't implemented on all
 
2363
            # platforms
 
2364
            try:
 
2365
                concurrency = _local_concurrency()
 
2366
            except (OSError, IOError):
 
2367
                pass
2241
2368
    try:
2242
2369
        concurrency = int(concurrency)
2243
2370
    except (TypeError, ValueError):
2255
2382
        self.encode = encode
2256
2383
 
2257
2384
    def write(self, object):
2258
 
        if type(object) is str:
 
2385
        if isinstance(object, str):
2259
2386
            self.stream.write(object)
2260
2387
        else:
2261
2388
            data, _ = self.encode(object, self.errors)
2264
2391
if sys.platform == 'win32':
2265
2392
    def open_file(filename, mode='r', bufsize=-1):
2266
2393
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2394
 
2268
2395
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2396
        child processes.  Deleting or renaming a closed file opened with this
2270
2397
        function is not blocking child processes.
2305
2432
    open_file = open
2306
2433
 
2307
2434
 
2308
 
def getuser_unicode():
2309
 
    """Return the username as unicode.
2310
 
    """
2311
 
    try:
2312
 
        user_encoding = get_user_encoding()
2313
 
        username = getpass.getuser().decode(user_encoding)
2314
 
    except UnicodeDecodeError:
2315
 
        raise errors.BzrError("Can't decode username as %s." % \
2316
 
                user_encoding)
2317
 
    return username
 
2435
def available_backup_name(base, exists):
 
2436
    """Find a non-existing backup file name.
 
2437
 
 
2438
    This will *not* create anything, this only return a 'free' entry.  This
 
2439
    should be used for checking names in a directory below a locked
 
2440
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2441
    Leap) and generally discouraged.
 
2442
 
 
2443
    :param base: The base name.
 
2444
 
 
2445
    :param exists: A callable returning True if the path parameter exists.
 
2446
    """
 
2447
    counter = 1
 
2448
    name = "%s.~%d~" % (base, counter)
 
2449
    while exists(name):
 
2450
        counter += 1
 
2451
        name = "%s.~%d~" % (base, counter)
 
2452
    return name
 
2453
 
 
2454
 
 
2455
def set_fd_cloexec(fd):
 
2456
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2457
    support for this is not available.
 
2458
    """
 
2459
    try:
 
2460
        import fcntl
 
2461
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2462
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2463
    except (ImportError, AttributeError):
 
2464
        # Either the fcntl module or specific constants are not present
 
2465
        pass
 
2466
 
 
2467
 
 
2468
def find_executable_on_path(name):
 
2469
    """Finds an executable on the PATH.
 
2470
    
 
2471
    On Windows, this will try to append each extension in the PATHEXT
 
2472
    environment variable to the name, if it cannot be found with the name
 
2473
    as given.
 
2474
    
 
2475
    :param name: The base name of the executable.
 
2476
    :return: The path to the executable found or None.
 
2477
    """
 
2478
    if sys.platform == 'win32':
 
2479
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2480
        exts = [ext.lower() for ext in exts]
 
2481
        base, ext = os.path.splitext(name)
 
2482
        if ext != '':
 
2483
            if ext.lower() not in exts:
 
2484
                return None
 
2485
            name = base
 
2486
            exts = [ext]
 
2487
    else:
 
2488
        exts = ['']
 
2489
    path = os.environ.get('PATH')
 
2490
    if path is not None:
 
2491
        path = path.split(os.pathsep)
 
2492
        for ext in exts:
 
2493
            for d in path:
 
2494
                f = os.path.join(d, name) + ext
 
2495
                if os.access(f, os.X_OK):
 
2496
                    return f
 
2497
    if sys.platform == 'win32':
 
2498
        app_path = win32utils.get_app_path(name)
 
2499
        if app_path != name:
 
2500
            return app_path
 
2501
    return None
 
2502
 
 
2503
 
 
2504
def _posix_is_local_pid_dead(pid):
 
2505
    """True if pid doesn't correspond to live process on this machine"""
 
2506
    try:
 
2507
        # Special meaning of unix kill: just check if it's there.
 
2508
        os.kill(pid, 0)
 
2509
    except OSError as e:
 
2510
        if e.errno == errno.ESRCH:
 
2511
            # On this machine, and really not found: as sure as we can be
 
2512
            # that it's dead.
 
2513
            return True
 
2514
        elif e.errno == errno.EPERM:
 
2515
            # exists, though not ours
 
2516
            return False
 
2517
        else:
 
2518
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2519
            # Don't really know.
 
2520
            return False
 
2521
    else:
 
2522
        # Exists and our process: not dead.
 
2523
        return False
 
2524
 
 
2525
if sys.platform == "win32":
 
2526
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2527
else:
 
2528
    is_local_pid_dead = _posix_is_local_pid_dead
 
2529
 
 
2530
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2531
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2532
                      if getattr(errno, name, None) is not None]
 
2533
 
 
2534
 
 
2535
def fdatasync(fileno):
 
2536
    """Flush file contents to disk if possible.
 
2537
    
 
2538
    :param fileno: Integer OS file handle.
 
2539
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2540
    """
 
2541
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2542
    if fn is not None:
 
2543
        try:
 
2544
            fn(fileno)
 
2545
        except IOError as e:
 
2546
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2547
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2548
            # and reduce the chance of corruption-on-powerloss situations. It
 
2549
            # is not a mandatory call, so it is ok to suppress failures.
 
2550
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2551
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2552
                raise
 
2553
 
 
2554
 
 
2555
def ensure_empty_directory_exists(path, exception_class):
 
2556
    """Make sure a local directory exists and is empty.
 
2557
    
 
2558
    If it does not exist, it is created.  If it exists and is not empty, an
 
2559
    instance of exception_class is raised.
 
2560
    """
 
2561
    try:
 
2562
        os.mkdir(path)
 
2563
    except OSError as e:
 
2564
        if e.errno != errno.EEXIST:
 
2565
            raise
 
2566
        if os.listdir(path) != []:
 
2567
            raise exception_class(path)
 
2568
 
 
2569
 
 
2570
def is_environment_error(evalue):
 
2571
    """True if exception instance is due to a process environment issue
 
2572
 
 
2573
    This includes OSError and IOError, but also other errors that come from
 
2574
    the operating system or core libraries but are not subclasses of those.
 
2575
    """
 
2576
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2577
        return True
 
2578
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2579
        return True
 
2580
    return False