/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 bzrlib/osutils.py

  • Committer: Andrew Bennetts
  • Date: 2011-06-09 07:38:32 UTC
  • mto: This revision was merged to the branch mainline in revision 5964.
  • Revision ID: andrew.bennetts@canonical.com-20110609073832-dt6oww033iexli4l
Fix thinko in wording regarding stacking invariants and revisions with multiple parents.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
22
22
import time
23
23
import codecs
24
24
 
25
 
from .lazy_import import lazy_import
 
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
28
28
import getpass
29
 
import locale
30
29
import ntpath
31
30
import posixpath
32
 
import select
33
31
# We need to import both shutil and rmtree as we export the later on posix
34
32
# and need the former on windows
35
33
import shutil
42
40
from tempfile import mkdtemp
43
41
import unicodedata
44
42
 
45
 
from breezy import (
46
 
    config,
 
43
from bzrlib import (
 
44
    cache_utf8,
 
45
    errors,
47
46
    trace,
48
47
    win32utils,
49
48
    )
50
 
from breezy.i18n import gettext
51
49
""")
52
50
 
 
51
from bzrlib.symbol_versioning import (
 
52
    deprecated_function,
 
53
    deprecated_in,
 
54
    )
 
55
 
53
56
from hashlib import (
54
57
    md5,
55
58
    sha1 as sha,
56
59
    )
57
60
 
58
61
 
59
 
import breezy
60
 
from . import (
61
 
    _fs_enc,
62
 
    errors,
63
 
    )
64
 
 
 
62
import bzrlib
 
63
from bzrlib import symbol_versioning
 
64
 
 
65
 
 
66
# Cross platform wall-clock time functionality with decent resolution.
 
67
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
68
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
69
# synchronized with ``time.time()``, this is only meant to be used to find
 
70
# delta times by subtracting from another call to this function.
 
71
timer_func = time.time
 
72
if sys.platform == 'win32':
 
73
    timer_func = time.clock
65
74
 
66
75
# On win32, O_BINARY is used to indicate the file should
67
76
# be opened in binary mode, rather than text mode.
74
83
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
75
84
 
76
85
 
77
 
class UnsupportedTimezoneFormat(errors.BzrError):
78
 
 
79
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
80
 
            'options are "utc", "original", "local".')
81
 
 
82
 
    def __init__(self, timezone):
83
 
        self.timezone = timezone
 
86
def get_unicode_argv():
 
87
    try:
 
88
        user_encoding = get_user_encoding()
 
89
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
90
    except UnicodeDecodeError:
 
91
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
 
92
            "application locale." % (a, user_encoding))
84
93
 
85
94
 
86
95
def make_readonly(filename):
87
96
    """Make a filename read-only."""
88
97
    mod = os.lstat(filename).st_mode
89
98
    if not stat.S_ISLNK(mod):
90
 
        mod = mod & 0o777555
91
 
        chmod_if_possible(filename, mod)
 
99
        mod = mod & 0777555
 
100
        os.chmod(filename, mod)
92
101
 
93
102
 
94
103
def make_writable(filename):
95
104
    mod = os.lstat(filename).st_mode
96
105
    if not stat.S_ISLNK(mod):
97
 
        mod = mod | 0o200
98
 
        chmod_if_possible(filename, mod)
99
 
 
100
 
 
101
 
def chmod_if_possible(filename, mode):
102
 
    # Set file mode if that can be safely done.
103
 
    # Sometimes even on unix the filesystem won't allow it - see
104
 
    # https://bugs.launchpad.net/bzr/+bug/606537
105
 
    try:
106
 
        # It is probably faster to just do the chmod, rather than
107
 
        # doing a stat, and then trying to compare
108
 
        os.chmod(filename, mode)
109
 
    except (IOError, OSError) as e:
110
 
        # Permission/access denied seems to commonly happen on smbfs; there's
111
 
        # probably no point warning about it.
112
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
113
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
114
 
            trace.mutter("ignore error on chmod of %r: %r" % (
115
 
                filename, e))
116
 
            return
117
 
        raise
 
106
        mod = mod | 0200
 
107
        os.chmod(filename, mod)
118
108
 
119
109
 
120
110
def minimum_path_selection(paths):
128
118
        return set(paths)
129
119
 
130
120
    def sort_key(path):
131
 
        if isinstance(path, bytes):
132
 
            return path.split(b'/')
133
 
        else:
134
 
            return path.split('/')
 
121
        return path.split('/')
135
122
    sorted_paths = sorted(list(paths), key=sort_key)
136
123
 
137
124
    search_paths = [sorted_paths[0]]
164
151
 
165
152
_directory_kind = 'directory'
166
153
 
167
 
 
168
154
def get_umask():
169
155
    """Return the current umask"""
170
156
    # Assume that people aren't messing with the umask while running
199
185
            stat = getattr(os, 'lstat', os.stat)
200
186
            stat(f)
201
187
            return True
202
 
        except OSError as e:
 
188
        except OSError, e:
203
189
            if e.errno == errno.ENOENT:
204
 
                return False
 
190
                return False;
205
191
            else:
206
 
                raise errors.BzrError(
207
 
                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
192
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
208
193
 
209
194
 
210
195
def fancy_rename(old, new, rename_func, unlink_func):
234
219
    file_existed = False
235
220
    try:
236
221
        rename_func(new, tmp_name)
237
 
    except (errors.NoSuchFile,):
 
222
    except (errors.NoSuchFile,), e:
238
223
        pass
239
 
    except IOError as e:
 
224
    except IOError, e:
240
225
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
241
226
        # function raises an IOError with errno is None when a rename fails.
242
227
        # This then gets caught here.
243
228
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
244
229
            raise
245
 
    except Exception as e:
 
230
    except Exception, e:
246
231
        if (getattr(e, 'errno', None) is None
247
 
                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
232
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
248
233
            raise
249
234
    else:
250
235
        file_existed = True
251
236
 
 
237
    failure_exc = None
252
238
    success = False
253
239
    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) as 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
 
        if (file_existed and e.errno in (None, errno.ENOENT)
 
240
        try:
 
241
            # This may throw an exception, in which case success will
 
242
            # not be set.
 
243
            rename_func(old, new)
 
244
            success = True
 
245
        except (IOError, OSError), e:
 
246
            # source and target may be aliases of each other (e.g. on a
 
247
            # case-insensitive filesystem), so we may have accidentally renamed
 
248
            # source by when we tried to rename target
 
249
            failure_exc = sys.exc_info()
 
250
            if (file_existed and e.errno in (None, errno.ENOENT)
263
251
                and old.lower() == new.lower()):
264
 
            # source and target are the same file on a case-insensitive
265
 
            # filesystem, so we don't generate an exception
266
 
            pass
267
 
        else:
268
 
            raise
 
252
                # source and target are the same file on a case-insensitive
 
253
                # filesystem, so we don't generate an exception
 
254
                failure_exc = None
269
255
    finally:
270
256
        if file_existed:
271
257
            # If the file used to exist, rename it back into place
274
260
                unlink_func(tmp_name)
275
261
            else:
276
262
                rename_func(tmp_name, new)
 
263
    if failure_exc is not None:
 
264
        try:
 
265
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
266
        finally:
 
267
            del failure_exc
277
268
 
278
269
 
279
270
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
280
271
# choke on a Unicode string containing a relative path if
281
272
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
282
273
# string.
 
274
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
283
275
def _posix_abspath(path):
284
276
    # jam 20060426 rather than encoding to fsencoding
285
277
    # copy posixpath.abspath, but use os.getcwdu instead
286
278
    if not posixpath.isabs(path):
287
279
        path = posixpath.join(getcwd(), path)
288
 
    return _posix_normpath(path)
 
280
    return posixpath.normpath(path)
289
281
 
290
282
 
291
283
def _posix_realpath(path):
292
284
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
293
285
 
294
286
 
295
 
def _posix_normpath(path):
296
 
    path = posixpath.normpath(path)
297
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
298
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
299
 
    # leading slashes must not be simplified to one, and only if there are 3 or
300
 
    # more should they be simplified as one. So we treat the leading 2 slashes
301
 
    # as a special case here by simply removing the first slash, as we consider
302
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
303
 
    # This is not a paranoid precaution, as we notably get paths like this when
304
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".
305
 
    if path.startswith('//'):
306
 
        path = path[1:]
307
 
    return path
308
 
 
309
 
 
310
 
def _posix_get_home_dir():
311
 
    """Get the home directory of the current user as a unicode path"""
312
 
    path = posixpath.expanduser("~")
313
 
    try:
314
 
        return path.decode(_fs_enc)
315
 
    except AttributeError:
316
 
        return path
317
 
    except UnicodeDecodeError:
318
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
319
 
 
320
 
 
321
 
def _posix_getuser_unicode():
322
 
    """Get username from environment or password database as unicode"""
323
 
    return getpass.getuser()
324
 
 
325
 
 
326
287
def _win32_fixdrive(path):
327
288
    """Force drive letters to be consistent.
328
289
 
338
299
 
339
300
def _win32_abspath(path):
340
301
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
341
 
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
 
302
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
303
 
 
304
 
 
305
def _win98_abspath(path):
 
306
    """Return the absolute version of a path.
 
307
    Windows 98 safe implementation (python reimplementation
 
308
    of Win32 API function GetFullPathNameW)
 
309
    """
 
310
    # Corner cases:
 
311
    #   C:\path     => C:/path
 
312
    #   C:/path     => C:/path
 
313
    #   \\HOST\path => //HOST/path
 
314
    #   //HOST/path => //HOST/path
 
315
    #   path        => C:/cwd/path
 
316
    #   /path       => C:/path
 
317
    path = unicode(path)
 
318
    # check for absolute path
 
319
    drive = ntpath.splitdrive(path)[0]
 
320
    if drive == '' and path[:2] not in('//','\\\\'):
 
321
        cwd = os.getcwdu()
 
322
        # we cannot simply os.path.join cwd and path
 
323
        # because os.path.join('C:','/path') produce '/path'
 
324
        # and this is incorrect
 
325
        if path[:1] in ('/','\\'):
 
326
            cwd = ntpath.splitdrive(cwd)[0]
 
327
            path = path[1:]
 
328
        path = cwd + '\\' + path
 
329
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
330
 
343
331
 
344
332
def _win32_realpath(path):
345
333
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
346
 
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
 
334
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
335
 
348
336
 
349
337
def _win32_pathjoin(*args):
351
339
 
352
340
 
353
341
def _win32_normpath(path):
354
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
342
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
343
 
356
344
 
357
345
def _win32_getcwd():
358
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
346
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
359
347
 
360
348
 
361
349
def _win32_mkdtemp(*args, **kwargs):
370
358
    """
371
359
    try:
372
360
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
373
 
    except OSError as e:
 
361
    except OSError, e:
374
362
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
375
363
            # If we try to rename a non-existant file onto cwd, we get
376
364
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
381
369
 
382
370
 
383
371
def _mac_getcwd():
384
 
    return unicodedata.normalize('NFC', _getcwd())
385
 
 
386
 
 
387
 
def _rename_wrap_exception(rename_func):
388
 
    """Adds extra information to any exceptions that come from rename().
389
 
 
390
 
    The exception has an updated message and 'old_filename' and 'new_filename'
391
 
    attributes.
392
 
    """
393
 
 
394
 
    def _rename_wrapper(old, new):
395
 
        try:
396
 
            rename_func(old, new)
397
 
        except OSError as e:
398
 
            detailed_error = OSError(e.errno, e.strerror +
399
 
                                     " [occurred when renaming '%s' to '%s']" %
400
 
                                     (old, new))
401
 
            detailed_error.old_filename = old
402
 
            detailed_error.new_filename = new
403
 
            raise detailed_error
404
 
 
405
 
    return _rename_wrapper
406
 
 
407
 
 
408
 
_getcwd = os.getcwd
409
 
 
410
 
 
411
 
# Default rename wraps os.rename()
412
 
rename = _rename_wrap_exception(os.rename)
 
372
    return unicodedata.normalize('NFC', os.getcwdu())
 
373
 
413
374
 
414
375
# Default is to just use the python builtins, but these can be rebound on
415
376
# particular platforms.
416
377
abspath = _posix_abspath
417
378
realpath = _posix_realpath
418
379
pathjoin = os.path.join
419
 
normpath = _posix_normpath
420
 
_get_home_dir = _posix_get_home_dir
421
 
getuser_unicode = _posix_getuser_unicode
422
 
getcwd = _getcwd
 
380
normpath = os.path.normpath
 
381
getcwd = os.getcwdu
 
382
rename = os.rename
423
383
dirname = os.path.dirname
424
384
basename = os.path.basename
425
385
split = os.path.split
430
390
lstat = os.lstat
431
391
fstat = os.fstat
432
392
 
433
 
 
434
393
def wrap_stat(st):
435
394
    return st
436
395
 
439
398
 
440
399
 
441
400
if sys.platform == 'win32':
442
 
    abspath = _win32_abspath
 
401
    if win32utils.winver == 'Windows 98':
 
402
        abspath = _win98_abspath
 
403
    else:
 
404
        abspath = _win32_abspath
443
405
    realpath = _win32_realpath
444
406
    pathjoin = _win32_pathjoin
445
407
    normpath = _win32_normpath
446
408
    getcwd = _win32_getcwd
447
409
    mkdtemp = _win32_mkdtemp
448
 
    rename = _rename_wrap_exception(_win32_rename)
 
410
    rename = _win32_rename
449
411
    try:
450
 
        from . import _walkdirs_win32
 
412
        from bzrlib import _walkdirs_win32
451
413
    except ImportError:
452
414
        pass
453
415
    else:
463
425
        """
464
426
        exception = excinfo[1]
465
427
        if function in (os.remove, os.rmdir) \
466
 
                and isinstance(exception, OSError) \
467
 
                and exception.errno == errno.EACCES:
 
428
            and isinstance(exception, OSError) \
 
429
            and exception.errno == errno.EACCES:
468
430
            make_writable(path)
469
431
            function(path)
470
432
        else:
474
436
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
475
437
        return shutil.rmtree(path, ignore_errors, onerror)
476
438
 
477
 
    _get_home_dir = win32utils.get_home_location
478
 
    getuser_unicode = win32utils.get_user_name
 
439
    f = win32utils.get_unicode_argv     # special function or None
 
440
    if f is not None:
 
441
        get_unicode_argv = f
479
442
 
480
443
elif sys.platform == 'darwin':
481
444
    getcwd = _mac_getcwd
496
459
 
497
460
    :param trace: If True trace the selected encoding via mutter().
498
461
    """
499
 
    from .trace import mutter
 
462
    from bzrlib.trace import mutter
500
463
    output_encoding = getattr(sys.stdout, 'encoding', None)
501
464
    if not output_encoding:
502
465
        input_encoding = getattr(sys.stdin, 'encoding', None)
504
467
            output_encoding = get_user_encoding()
505
468
            if trace:
506
469
                mutter('encoding stdout as osutils.get_user_encoding() %r',
507
 
                       output_encoding)
 
470
                   output_encoding)
508
471
        else:
509
472
            output_encoding = input_encoding
510
473
            if trace:
511
474
                mutter('encoding stdout as sys.stdin encoding %r',
512
 
                       output_encoding)
 
475
                    output_encoding)
513
476
    else:
514
477
        if trace:
515
478
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
518
481
        output_encoding = get_user_encoding()
519
482
        if trace:
520
483
            mutter('cp0 is invalid encoding.'
521
 
                   ' encoding stdout as osutils.get_user_encoding() %r',
522
 
                   output_encoding)
 
484
               ' encoding stdout as osutils.get_user_encoding() %r',
 
485
               output_encoding)
523
486
    # check encoding
524
487
    try:
525
488
        codecs.lookup(output_encoding)
526
489
    except LookupError:
527
 
        sys.stderr.write('brz: warning:'
 
490
        sys.stderr.write('bzr: warning:'
528
491
                         ' unknown terminal encoding %s.\n'
529
492
                         '  Using encoding %s instead.\n'
530
493
                         % (output_encoding, get_user_encoding())
531
 
                         )
 
494
                        )
532
495
        output_encoding = get_user_encoding()
533
496
 
534
497
    return output_encoding
539
502
        F = realpath
540
503
    else:
541
504
        F = abspath
542
 
    [p, e] = os.path.split(f)
 
505
    [p,e] = os.path.split(f)
543
506
    if e == "" or e == "." or e == "..":
544
507
        return F(f)
545
508
    else:
561
524
    except OSError:
562
525
        return False
563
526
 
564
 
 
565
527
def islink(f):
566
528
    """True if f is a symlink."""
567
529
    try:
569
531
    except OSError:
570
532
        return False
571
533
 
572
 
 
573
534
def is_inside(dir, fname):
574
535
    """True if fname is inside dir.
575
536
 
585
546
    if dir == fname:
586
547
        return True
587
548
 
588
 
    if dir in ('', b''):
 
549
    if dir == '':
589
550
        return True
590
551
 
591
 
    if isinstance(dir, bytes):
592
 
        if not dir.endswith(b'/'):
593
 
            dir += b'/'
594
 
    else:
595
 
        if not dir.endswith('/'):
596
 
            dir += '/'
 
552
    if dir[-1] != '/':
 
553
        dir += '/'
597
554
 
598
555
    return fname.startswith(dir)
599
556
 
672
629
    # writes fail on some platforms (e.g. Windows with SMB  mounted
673
630
    # drives).
674
631
    if not segment_size:
675
 
        segment_size = 5242880  # 5MB
676
 
    offsets = range(0, len(bytes), segment_size)
677
 
    view = memoryview(bytes)
 
632
        segment_size = 5242880 # 5MB
 
633
    segments = range(len(bytes) / segment_size + 1)
678
634
    write = file_handle.write
679
 
    for offset in offsets:
680
 
        write(view[offset:offset + segment_size])
 
635
    for segment_index in segments:
 
636
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
637
        write(segment)
681
638
 
682
639
 
683
640
def file_iterator(input_file, readsize=32768):
688
645
        yield b
689
646
 
690
647
 
691
 
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
692
 
# used as bytes through most interfaces so encode with this wrapper.
693
 
def _hexdigest(hashobj):
694
 
    return hashobj.hexdigest().encode()
695
 
 
696
 
 
697
648
def sha_file(f):
698
649
    """Calculate the hexdigest of an open file.
699
650
 
700
651
    The file cursor should be already at the start.
701
652
    """
702
653
    s = sha()
703
 
    BUFSIZE = 128 << 10
 
654
    BUFSIZE = 128<<10
704
655
    while True:
705
656
        b = f.read(BUFSIZE)
706
657
        if not b:
707
658
            break
708
659
        s.update(b)
709
 
    return _hexdigest(s)
 
660
    return s.hexdigest()
710
661
 
711
662
 
712
663
def size_sha_file(f):
717
668
    """
718
669
    size = 0
719
670
    s = sha()
720
 
    BUFSIZE = 128 << 10
 
671
    BUFSIZE = 128<<10
721
672
    while True:
722
673
        b = f.read(BUFSIZE)
723
674
        if not b:
724
675
            break
725
676
        size += len(b)
726
677
        s.update(b)
727
 
    return size, _hexdigest(s)
 
678
    return size, s.hexdigest()
728
679
 
729
680
 
730
681
def sha_file_by_name(fname):
733
684
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
734
685
    try:
735
686
        while True:
736
 
            b = os.read(f, 1 << 16)
 
687
            b = os.read(f, 1<<16)
737
688
            if not b:
738
 
                return _hexdigest(s)
 
689
                return s.hexdigest()
739
690
            s.update(b)
740
691
    finally:
741
692
        os.close(f)
744
695
def sha_strings(strings, _factory=sha):
745
696
    """Return the sha-1 of concatenation of strings"""
746
697
    s = _factory()
747
 
    for string in strings:
748
 
        s.update(string)
749
 
    return _hexdigest(s)
 
698
    map(s.update, strings)
 
699
    return s.hexdigest()
750
700
 
751
701
 
752
702
def sha_string(f, _factory=sha):
753
 
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
754
 
    return _hexdigest(_factory(f))
 
703
    return _factory(f).hexdigest()
755
704
 
756
705
 
757
706
def fingerprint_file(f):
758
707
    b = f.read()
759
708
    return {'size': len(b),
760
 
            'sha1': _hexdigest(sha(b))}
 
709
            'sha1': sha(b).hexdigest()}
761
710
 
762
711
 
763
712
def compare_files(a, b):
768
717
        bi = b.read(BUFSIZE)
769
718
        if ai != bi:
770
719
            return False
771
 
        if not ai:
 
720
        if ai == '':
772
721
            return True
773
722
 
774
723
 
779
728
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
780
729
    return offset.days * 86400 + offset.seconds
781
730
 
782
 
 
783
731
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
784
732
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
785
733
 
797
745
    :param show_offset: Whether to append the timezone.
798
746
    """
799
747
    (date_fmt, tt, offset_str) = \
800
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
748
               _format_date(t, offset, timezone, date_fmt, show_offset)
801
749
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
802
750
    date_str = time.strftime(date_fmt, tt)
803
751
    return date_str + offset_str
808
756
 
809
757
 
810
758
def format_date_with_offset_in_original_timezone(t, offset=0,
811
 
                                                 _cache=_offset_cache):
 
759
    _cache=_offset_cache):
812
760
    """Return a formatted date string in the original timezone.
813
761
 
814
762
    This routine may be faster then format_date.
841
789
    :param show_offset: Whether to append the timezone.
842
790
    """
843
791
    (date_fmt, tt, offset_str) = \
844
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
792
               _format_date(t, offset, timezone, date_fmt, show_offset)
845
793
    date_str = time.strftime(date_fmt, tt)
846
 
    if not isinstance(date_str, str):
 
794
    if not isinstance(date_str, unicode):
847
795
        date_str = date_str.decode(get_user_encoding(), 'replace')
848
796
    return date_str + offset_str
849
797
 
860
808
        tt = time.localtime(t)
861
809
        offset = local_time_offset(t)
862
810
    else:
863
 
        raise UnsupportedTimezoneFormat(timezone)
 
811
        raise errors.UnsupportedTimezoneFormat(timezone)
864
812
    if date_fmt is None:
865
813
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
866
814
    if show_offset:
890
838
        delta = -delta
891
839
 
892
840
    seconds = delta
893
 
    if seconds < 90:  # print seconds up to 90 seconds
 
841
    if seconds < 90: # print seconds up to 90 seconds
894
842
        if seconds == 1:
895
843
            return '%d second %s' % (seconds, direction,)
896
844
        else:
902
850
        plural_seconds = ''
903
851
    else:
904
852
        plural_seconds = 's'
905
 
    if minutes < 90:  # print minutes, seconds up to 90 minutes
 
853
    if minutes < 90: # print minutes, seconds up to 90 minutes
906
854
        if minutes == 1:
907
855
            return '%d minute, %d second%s %s' % (
908
 
                minutes, seconds, plural_seconds, direction)
 
856
                    minutes, seconds, plural_seconds, direction)
909
857
        else:
910
858
            return '%d minutes, %d second%s %s' % (
911
 
                minutes, seconds, plural_seconds, direction)
 
859
                    minutes, seconds, plural_seconds, direction)
912
860
 
913
861
    hours = int(minutes / 60)
914
862
    minutes -= 60 * hours
923
871
    return '%d hours, %d minute%s %s' % (hours, minutes,
924
872
                                         plural_minutes, direction)
925
873
 
926
 
 
927
874
def filesize(f):
928
875
    """Return size of given open file."""
929
876
    return os.fstat(f.fileno())[stat.ST_SIZE]
930
877
 
931
878
 
932
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and
933
 
# override if it doesn't work. Avoid checking on windows where there is
934
 
# significant initialisation cost that can be avoided for some bzr calls.
935
 
 
936
 
rand_bytes = os.urandom
937
 
 
938
 
if rand_bytes.__module__ != "nt":
 
879
# Define rand_bytes based on platform.
 
880
try:
 
881
    # Python 2.4 and later have os.urandom,
 
882
    # but it doesn't work on some arches
 
883
    os.urandom(1)
 
884
    rand_bytes = os.urandom
 
885
except (NotImplementedError, AttributeError):
 
886
    # If python doesn't have os.urandom, or it doesn't work,
 
887
    # then try to first pull random data from /dev/urandom
939
888
    try:
940
 
        rand_bytes(1)
941
 
    except NotImplementedError:
 
889
        rand_bytes = file('/dev/urandom', 'rb').read
 
890
    # Otherwise, use this hack as a last resort
 
891
    except (IOError, OSError):
942
892
        # not well seeded, but better than nothing
943
893
        def rand_bytes(n):
944
894
            import random
950
900
 
951
901
 
952
902
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
953
 
 
954
 
 
955
903
def rand_chars(num):
956
904
    """Return a random string of num alphanumeric characters
957
905
 
960
908
    """
961
909
    s = ''
962
910
    for raw_byte in rand_bytes(num):
963
 
        s += ALNUM[raw_byte % 36]
 
911
        s += ALNUM[ord(raw_byte) % 36]
964
912
    return s
965
913
 
966
914
 
967
 
# TODO: We could later have path objects that remember their list
968
 
# decomposition (might be too tricksy though.)
 
915
## TODO: We could later have path objects that remember their list
 
916
## decomposition (might be too tricksy though.)
969
917
 
970
918
def splitpath(p):
971
919
    """Turn string into list of parts."""
972
 
    use_bytes = isinstance(p, bytes)
973
 
    if os.path.sep == '\\':
974
 
        # split on either delimiter because people might use either on
975
 
        # Windows
976
 
        if use_bytes:
977
 
            ps = re.split(b'[\\\\/]', p)
978
 
        else:
979
 
            ps = re.split(r'[\\/]', p)
980
 
    else:
981
 
        if use_bytes:
982
 
            ps = p.split(b'/')
983
 
        else:
984
 
            ps = p.split('/')
985
 
 
986
 
    if use_bytes:
987
 
        parent_dir = b'..'
988
 
        current_empty_dir = (b'.', b'')
989
 
    else:
990
 
        parent_dir = '..'
991
 
        current_empty_dir = ('.', '')
 
920
    # split on either delimiter because people might use either on
 
921
    # Windows
 
922
    ps = re.split(r'[\\/]', p)
992
923
 
993
924
    rps = []
994
925
    for f in ps:
995
 
        if f == parent_dir:
996
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
997
 
        elif f in current_empty_dir:
 
926
        if f == '..':
 
927
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
928
        elif (f == '.') or (f == ''):
998
929
            pass
999
930
        else:
1000
931
            rps.append(f)
1004
935
def joinpath(p):
1005
936
    for f in p:
1006
937
        if (f == '..') or (f is None) or (f == ''):
1007
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
938
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1008
939
    return pathjoin(*p)
1009
940
 
1010
941
 
1032
963
    implementation should be loaded instead::
1033
964
 
1034
965
    >>> try:
1035
 
    >>>     import breezy._fictional_extension_pyx
 
966
    >>>     import bzrlib._fictional_extension_pyx
1036
967
    >>> except ImportError, e:
1037
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1038
 
    >>>     import breezy._fictional_extension_py
 
968
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
969
    >>>     import bzrlib._fictional_extension_py
1039
970
    """
1040
971
    # NB: This docstring is just an example, not a doctest, because doctest
1041
972
    # currently can't cope with the use of lazy imports in this namespace --
1054
985
def report_extension_load_failures():
1055
986
    if not _extension_load_failures:
1056
987
        return
1057
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
988
    from bzrlib.config import GlobalConfig
 
989
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1058
990
        return
1059
991
    # the warnings framework should by default show this only once
1060
 
    from .trace import warning
 
992
    from bzrlib.trace import warning
1061
993
    warning(
1062
 
        "brz: warning: some compiled extensions could not be loaded; "
1063
 
        "see ``brz help missing-extensions``")
 
994
        "bzr: warning: some compiled extensions could not be loaded; "
 
995
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1064
996
    # we no longer show the specific missing extensions here, because it makes
1065
997
    # the message too long and scary - see
1066
998
    # https://bugs.launchpad.net/bzr/+bug/430529
1067
999
 
1068
1000
 
1069
1001
try:
1070
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1071
 
except ImportError as e:
 
1002
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1003
except ImportError, e:
1072
1004
    failed_to_load_extension(e)
1073
 
    from ._chunks_to_lines_py import chunks_to_lines
 
1005
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1074
1006
 
1075
1007
 
1076
1008
def split_lines(s):
1077
1009
    """Split s into lines, but without removing the newline characters."""
1078
1010
    # Trivially convert a fulltext into a 'chunked' representation, and let
1079
1011
    # chunks_to_lines do the heavy lifting.
1080
 
    if isinstance(s, bytes):
 
1012
    if isinstance(s, str):
1081
1013
        # chunks_to_lines only supports 8-bit strings
1082
1014
        return chunks_to_lines([s])
1083
1015
    else:
1089
1021
 
1090
1022
    This supports Unicode or plain string objects.
1091
1023
    """
1092
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1093
 
    lines = s.split(nl)
1094
 
    result = [line + nl for line in lines[:-1]]
 
1024
    lines = s.split('\n')
 
1025
    result = [line + '\n' for line in lines[:-1]]
1095
1026
    if lines[-1]:
1096
1027
        result.append(lines[-1])
1097
1028
    return result
1108
1039
        return
1109
1040
    try:
1110
1041
        os.link(src, dest)
1111
 
    except (OSError, IOError) as e:
 
1042
    except (OSError, IOError), e:
1112
1043
        if e.errno != errno.EXDEV:
1113
1044
            raise
1114
1045
        shutil.copyfile(src, dest)
1120
1051
    Will delete even if readonly.
1121
1052
    """
1122
1053
    try:
1123
 
        _delete_file_or_dir(path)
1124
 
    except (OSError, IOError) as e:
 
1054
       _delete_file_or_dir(path)
 
1055
    except (OSError, IOError), e:
1125
1056
        if e.errno in (errno.EPERM, errno.EACCES):
1126
1057
            # make writable and try again
1127
1058
            try:
1139
1070
    # - root can damage a solaris file system by using unlink,
1140
1071
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1141
1072
    #   EACCES, OSX: EPERM) when invoked on a directory.
1142
 
    if isdir(path):  # Takes care of symlinks
 
1073
    if isdir(path): # Takes care of symlinks
1143
1074
        os.rmdir(path)
1144
1075
    else:
1145
1076
        os.unlink(path)
1187
1118
    #    separators
1188
1119
    # 3) '\xa0' isn't unicode safe since it is >128.
1189
1120
 
1190
 
    if isinstance(s, str):
1191
 
        ws = ' \t\n\r\v\f'
1192
 
    else:
1193
 
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
1194
 
    for ch in ws:
 
1121
    # This should *not* be a unicode set of characters in case the source
 
1122
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1123
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1124
    # is utf-8
 
1125
    for ch in ' \t\n\r\v\f':
1195
1126
        if ch in s:
1196
1127
            return True
1197
1128
    else:
1223
1154
 
1224
1155
    if len(base) < MIN_ABS_PATHLENGTH:
1225
1156
        # must have space for e.g. a drive letter
1226
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
1227
 
                         % (base,))
 
1157
        raise ValueError('%r is too short to calculate a relative path'
 
1158
            % (base,))
1228
1159
 
1229
1160
    rp = abspath(path)
1230
1161
 
1267
1198
 
1268
1199
    abs_base = abspath(base)
1269
1200
    current = abs_base
 
1201
    _listdir = os.listdir
1270
1202
 
1271
1203
    # use an explicit iterator so we can easily consume the rest on early exit.
1272
1204
    bit_iter = iter(rel.split('/'))
1273
1205
    for bit in bit_iter:
1274
1206
        lbit = bit.lower()
1275
1207
        try:
1276
 
            next_entries = scandir(current)
1277
 
        except OSError:  # enoent, eperm, etc
 
1208
            next_entries = _listdir(current)
 
1209
        except OSError: # enoent, eperm, etc
1278
1210
            # We can't find this in the filesystem, so just append the
1279
1211
            # remaining bits.
1280
1212
            current = pathjoin(current, bit, *list(bit_iter))
1281
1213
            break
1282
 
        for entry in next_entries:
1283
 
            if lbit == entry.name.lower():
1284
 
                current = entry.path
 
1214
        for look in next_entries:
 
1215
            if lbit == look.lower():
 
1216
                current = pathjoin(current, look)
1285
1217
                break
1286
1218
        else:
1287
1219
            # got to the end, nothing matched, so we just return the
1291
1223
            break
1292
1224
    return current[len(abs_base):].lstrip('/')
1293
1225
 
1294
 
 
1295
1226
# XXX - TODO - we need better detection/integration of case-insensitive
1296
1227
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1297
1228
# filesystems), for example, so could probably benefit from the same basic
1302
1233
else:
1303
1234
    canonical_relpath = relpath
1304
1235
 
1305
 
 
1306
1236
def canonical_relpaths(base, paths):
1307
1237
    """Create an iterable to canonicalize a sequence of relative paths.
1308
1238
 
1320
1250
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1321
1251
    fails, a errors.BadFilenameEncoding exception is raised.
1322
1252
    """
1323
 
    if isinstance(filename, str):
 
1253
    if type(filename) is unicode:
1324
1254
        return filename
1325
1255
    try:
1326
1256
        return filename.decode(_fs_enc)
1335
1265
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1336
1266
    wrapped in a BzrBadParameterNotUnicode exception.
1337
1267
    """
1338
 
    if isinstance(unicode_or_utf8_string, str):
 
1268
    if isinstance(unicode_or_utf8_string, unicode):
1339
1269
        return unicode_or_utf8_string
1340
1270
    try:
1341
1271
        return unicode_or_utf8_string.decode('utf8')
1349
1279
    If it is a str, it is returned.
1350
1280
    If it is Unicode, it is encoded into a utf-8 string.
1351
1281
    """
1352
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1282
    if isinstance(unicode_or_utf8_string, str):
1353
1283
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1354
1284
        #       performance if we are dealing with lots of apis that want a
1355
1285
        #       utf-8 revision id
1362
1292
    return unicode_or_utf8_string.encode('utf-8')
1363
1293
 
1364
1294
 
 
1295
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1296
                        ' Revision id generators should be creating utf8'
 
1297
                        ' revision ids.')
 
1298
 
 
1299
 
 
1300
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
1301
    """Revision ids should now be utf8, but at one point they were unicode.
 
1302
 
 
1303
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
1304
        utf8 or None).
 
1305
    :param warn: Functions that are sanitizing user data can set warn=False
 
1306
    :return: None or a utf8 revision id.
 
1307
    """
 
1308
    if (unicode_or_utf8_string is None
 
1309
        or unicode_or_utf8_string.__class__ == str):
 
1310
        return unicode_or_utf8_string
 
1311
    if warn:
 
1312
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1313
                               stacklevel=2)
 
1314
    return cache_utf8.encode(unicode_or_utf8_string)
 
1315
 
 
1316
 
 
1317
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1318
                    ' generators should be creating utf8 file ids.')
 
1319
 
 
1320
 
 
1321
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1322
    """File ids should now be utf8, but at one point they were unicode.
 
1323
 
 
1324
    This is the same as safe_utf8, except it uses the cached encode functions
 
1325
    to save a little bit of performance.
 
1326
 
 
1327
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
1328
        utf8 or None).
 
1329
    :param warn: Functions that are sanitizing user data can set warn=False
 
1330
    :return: None or a utf8 file id.
 
1331
    """
 
1332
    if (unicode_or_utf8_string is None
 
1333
        or unicode_or_utf8_string.__class__ == str):
 
1334
        return unicode_or_utf8_string
 
1335
    if warn:
 
1336
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1337
                               stacklevel=2)
 
1338
    return cache_utf8.encode(unicode_or_utf8_string)
 
1339
 
 
1340
 
1365
1341
_platform_normalizes_filenames = False
1366
1342
if sys.platform == 'darwin':
1367
1343
    _platform_normalizes_filenames = True
1390
1366
    can be accessed by that path.
1391
1367
    """
1392
1368
 
1393
 
    if isinstance(path, bytes):
1394
 
        path = path.decode(sys.getfilesystemencoding())
1395
 
    return unicodedata.normalize('NFC', path), True
 
1369
    return unicodedata.normalize('NFC', unicode(path)), True
1396
1370
 
1397
1371
 
1398
1372
def _inaccessible_normalized_filename(path):
1399
1373
    __doc__ = _accessible_normalized_filename.__doc__
1400
1374
 
1401
 
    if isinstance(path, bytes):
1402
 
        path = path.decode(sys.getfilesystemencoding())
1403
 
    normalized = unicodedata.normalize('NFC', path)
 
1375
    normalized = unicodedata.normalize('NFC', unicode(path))
1404
1376
    return normalized, normalized == path
1405
1377
 
1406
1378
 
1429
1401
    except AttributeError:
1430
1402
        # siginterrupt doesn't exist on this platform, or for this version
1431
1403
        # of Python.
1432
 
        def siginterrupt(signum, flag): return None
 
1404
        siginterrupt = lambda signum, flag: None
1433
1405
    if restart_syscall:
1434
1406
        def sig_handler(*args):
1435
1407
            # Python resets the siginterrupt flag when a signal is
1460
1432
_terminal_size_state = 'no_data'
1461
1433
_first_terminal_size = None
1462
1434
 
1463
 
 
1464
1435
def terminal_width():
1465
1436
    """Return terminal width.
1466
1437
 
1467
1438
    None is returned if the width can't established precisely.
1468
1439
 
1469
1440
    The rules are:
1470
 
    - if BRZ_COLUMNS is set, returns its value
 
1441
    - if BZR_COLUMNS is set, returns its value
1471
1442
    - if there is no controlling terminal, returns None
1472
1443
    - query the OS, if the queried size has changed since the last query,
1473
1444
      return its value,
1488
1459
    # Note to implementors: if changing the rules for determining the width,
1489
1460
    # make sure you've considered the behaviour in these cases:
1490
1461
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1491
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1462
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1492
1463
    #    0,0.
1493
1464
    #  - (add more interesting cases here, if you find any)
1494
1465
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1498
1469
    # time so we can notice if the reported size has changed, which should have
1499
1470
    # a similar effect.
1500
1471
 
1501
 
    # If BRZ_COLUMNS is set, take it, user is always right
 
1472
    # If BZR_COLUMNS is set, take it, user is always right
1502
1473
    # Except if they specified 0 in which case, impose no limit here
1503
1474
    try:
1504
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1475
        width = int(os.environ['BZR_COLUMNS'])
1505
1476
    except (KeyError, ValueError):
1506
1477
        width = None
1507
1478
    if width is not None:
1512
1483
 
1513
1484
    isatty = getattr(sys.stdout, 'isatty', None)
1514
1485
    if isatty is None or not isatty():
1515
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1486
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1516
1487
        return None
1517
1488
 
1518
1489
    # Query the OS
1547
1518
 
1548
1519
 
1549
1520
def _win32_terminal_size(width, height):
1550
 
    width, height = win32utils.get_console_size(
1551
 
        defaultx=width, defaulty=height)
 
1521
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1552
1522
    return width, height
1553
1523
 
1554
1524
 
1555
1525
def _ioctl_terminal_size(width, height):
1556
1526
    try:
1557
 
        import struct
1558
 
        import fcntl
1559
 
        import termios
 
1527
        import struct, fcntl, termios
1560
1528
        s = struct.pack('HHHH', 0, 0, 0, 0)
1561
1529
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1562
1530
        height, width = struct.unpack('HHHH', x)[0:2]
1564
1532
        pass
1565
1533
    return width, height
1566
1534
 
1567
 
 
1568
1535
_terminal_size = None
1569
1536
"""Returns the terminal size as (width, height).
1570
1537
 
1580
1547
    _terminal_size = _ioctl_terminal_size
1581
1548
 
1582
1549
 
1583
 
def supports_executable(path):
1584
 
    """Return if filesystem at path supports executable bit.
1585
 
 
1586
 
    :param path: Path for which to check the file system
1587
 
    :return: boolean indicating whether executable bit can be stored/relied upon
1588
 
    """
1589
 
    if sys.platform == 'win32':
1590
 
        return False
1591
 
    try:
1592
 
        fs_type = get_fs_type(path)
1593
 
    except errors.DependencyNotPresent as e:
1594
 
        trace.mutter('Unable to get fs type for %r: %s', path, e)
1595
 
    else:
1596
 
        if fs_type in ('vfat', 'ntfs'):
1597
 
            # filesystems known to not support executable bit
1598
 
            return False
1599
 
    return True
1600
 
 
1601
 
 
1602
 
def supports_symlinks(path):
1603
 
    """Return if the filesystem at path supports the creation of symbolic links.
1604
 
 
1605
 
    """
1606
 
    if not has_symlinks():
1607
 
        return False
1608
 
    try:
1609
 
        fs_type = get_fs_type(path)
1610
 
    except errors.DependencyNotPresent as e:
1611
 
        trace.mutter('Unable to get fs type for %r: %s', path, e)
1612
 
    else:
1613
 
        if fs_type in ('vfat', 'ntfs'):
1614
 
            # filesystems known to not support symlinks
1615
 
            return False
1616
 
    return True
 
1550
def supports_executable():
 
1551
    return sys.platform != "win32"
1617
1552
 
1618
1553
 
1619
1554
def supports_posix_readonly():
1642
1577
        if orig_val is not None:
1643
1578
            del os.environ[env_variable]
1644
1579
    else:
 
1580
        if isinstance(value, unicode):
 
1581
            value = value.encode(get_user_encoding())
1645
1582
        os.environ[env_variable] = value
1646
1583
    return orig_val
1647
1584
 
1660
1597
        raise errors.IllegalPath(path)
1661
1598
 
1662
1599
 
1663
 
_WIN32_ERROR_DIRECTORY = 267  # Similar to errno.ENOTDIR
1664
 
 
1665
 
 
1666
 
try:
1667
 
    scandir = os.scandir
1668
 
except AttributeError:  # Python < 3
1669
 
    lazy_import(globals(), """\
1670
 
from scandir import scandir
1671
 
""")
1672
 
 
 
1600
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1673
1601
 
1674
1602
def _is_error_enotdir(e):
1675
1603
    """Check if this exception represents ENOTDIR.
1687
1615
    :return: True if this represents an ENOTDIR error. False otherwise.
1688
1616
    """
1689
1617
    en = getattr(e, 'errno', None)
1690
 
    if (en == errno.ENOTDIR or
1691
 
        (sys.platform == 'win32' and
1692
 
            (en == _WIN32_ERROR_DIRECTORY or
1693
 
             (en == errno.EINVAL
1694
 
              and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1695
 
             ))):
 
1618
    if (en == errno.ENOTDIR
 
1619
        or (sys.platform == 'win32'
 
1620
            and (en == _WIN32_ERROR_DIRECTORY
 
1621
                 or (en == errno.EINVAL
 
1622
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1623
        ))):
1696
1624
        return True
1697
1625
    return False
1698
1626
 
1725
1653
        rooted higher up.
1726
1654
    :return: an iterator over the dirs.
1727
1655
    """
1728
 
    # TODO there is a bit of a smell where the results of the directory-
 
1656
    #TODO there is a bit of a smell where the results of the directory-
1729
1657
    # summary in this, and the path from the root, may not agree
1730
1658
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1731
1659
    # potentially confusing output. We should make this more robust - but
1732
1660
    # not at a speed cost. RBC 20060731
 
1661
    _lstat = os.lstat
1733
1662
    _directory = _directory_kind
 
1663
    _listdir = os.listdir
 
1664
    _kind_from_mode = file_kind_from_stat_mode
1734
1665
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1735
1666
    while pending:
1736
1667
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1742
1673
        top_slash = top + u'/'
1743
1674
 
1744
1675
        dirblock = []
 
1676
        append = dirblock.append
1745
1677
        try:
1746
 
            for entry in scandir(top):
1747
 
                name = decode_filename(entry.name)
1748
 
                statvalue = entry.stat(follow_symlinks=False)
1749
 
                kind = file_kind_from_stat_mode(statvalue.st_mode)
1750
 
                dirblock.append((relprefix + name, name, kind, statvalue, entry.path))
1751
 
        except OSError as e:
 
1678
            names = sorted(map(decode_filename, _listdir(top)))
 
1679
        except OSError, e:
1752
1680
            if not _is_error_enotdir(e):
1753
1681
                raise
1754
 
        except UnicodeDecodeError as e:
1755
 
            raise errors.BadFilenameEncoding(e.object, _fs_enc)
1756
 
        dirblock.sort()
 
1682
        else:
 
1683
            for name in names:
 
1684
                abspath = top_slash + name
 
1685
                statvalue = _lstat(abspath)
 
1686
                kind = _kind_from_mode(statvalue.st_mode)
 
1687
                append((relprefix + name, name, kind, statvalue, abspath))
1757
1688
        yield (relroot, top), dirblock
1758
1689
 
1759
1690
        # push the user specified dirs from dirblock
1804
1735
    """
1805
1736
    global _selected_dir_reader
1806
1737
    if _selected_dir_reader is None:
1807
 
        if sys.platform == "win32":
 
1738
        fs_encoding = _fs_enc.upper()
 
1739
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1740
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1741
            # TODO: We possibly could support Win98 by falling back to the
 
1742
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1743
            #       but that gets a bit tricky, and requires custom compiling
 
1744
            #       for win98 anyway.
1808
1745
            try:
1809
 
                from ._walkdirs_win32 import Win32ReadDir
 
1746
                from bzrlib._walkdirs_win32 import Win32ReadDir
1810
1747
                _selected_dir_reader = Win32ReadDir()
1811
1748
            except ImportError:
1812
1749
                pass
1813
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1750
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1751
            # ANSI_X3.4-1968 is a form of ASCII
1814
1752
            try:
1815
 
                from ._readdir_pyx import UTF8DirReader
 
1753
                from bzrlib._readdir_pyx import UTF8DirReader
1816
1754
                _selected_dir_reader = UTF8DirReader()
1817
 
            except ImportError as e:
 
1755
            except ImportError, e:
1818
1756
                failed_to_load_extension(e)
1819
1757
                pass
1820
1758
 
1865
1803
        See DirReader.read_dir for details.
1866
1804
        """
1867
1805
        _utf8_encode = self._utf8_encode
1868
 
 
1869
 
        def _fs_decode(s): return s.decode(_fs_enc)
1870
 
 
1871
 
        def _fs_encode(s): return s.encode(_fs_enc)
 
1806
        _lstat = os.lstat
 
1807
        _listdir = os.listdir
 
1808
        _kind_from_mode = file_kind_from_stat_mode
1872
1809
 
1873
1810
        if prefix:
1874
 
            relprefix = prefix + b'/'
 
1811
            relprefix = prefix + '/'
1875
1812
        else:
1876
 
            relprefix = b''
1877
 
        top_slash = top + '/'
 
1813
            relprefix = ''
 
1814
        top_slash = top + u'/'
1878
1815
 
1879
1816
        dirblock = []
1880
1817
        append = dirblock.append
1881
 
        for entry in scandir(safe_utf8(top)):
 
1818
        for name in sorted(_listdir(top)):
1882
1819
            try:
1883
 
                name = _fs_decode(entry.name)
 
1820
                name_utf8 = _utf8_encode(name)[0]
1884
1821
            except UnicodeDecodeError:
1885
1822
                raise errors.BadFilenameEncoding(
1886
 
                    relprefix + entry.name, _fs_enc)
 
1823
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1887
1824
            abspath = top_slash + name
1888
 
            name_utf8 = _utf8_encode(name)[0]
1889
 
            statvalue = entry.stat(follow_symlinks=False)
1890
 
            kind = file_kind_from_stat_mode(statvalue.st_mode)
 
1825
            statvalue = _lstat(abspath)
 
1826
            kind = _kind_from_mode(statvalue.st_mode)
1891
1827
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1892
 
        return sorted(dirblock)
 
1828
        return dirblock
1893
1829
 
1894
1830
 
1895
1831
def copy_tree(from_path, to_path, handlers={}):
1920
1856
        link_to = os.readlink(source)
1921
1857
        os.symlink(link_to, dest)
1922
1858
 
1923
 
    real_handlers = {'file': shutil.copy2,
1924
 
                     'symlink': copy_link,
1925
 
                     'directory': copy_dir,
1926
 
                     }
 
1859
    real_handlers = {'file':shutil.copy2,
 
1860
                     'symlink':copy_link,
 
1861
                     'directory':copy_dir,
 
1862
                    }
1927
1863
    real_handlers.update(handlers)
1928
1864
 
1929
1865
    if not os.path.exists(to_path):
1944
1880
    if chown is None:
1945
1881
        return
1946
1882
 
1947
 
    if src is None:
 
1883
    if src == None:
1948
1884
        src = os.path.dirname(dst)
1949
1885
        if src == '':
1950
1886
            src = '.'
1952
1888
    try:
1953
1889
        s = os.stat(src)
1954
1890
        chown(dst, s.st_uid, s.st_gid)
1955
 
    except OSError:
 
1891
    except OSError, e:
1956
1892
        trace.warning(
1957
1893
            'Unable to copy ownership from "%s" to "%s". '
1958
1894
            'You may want to set it manually.', src, dst)
1964
1900
 
1965
1901
    This can be used to sort paths in the same way that walkdirs does.
1966
1902
    """
1967
 
    return (dirname(path), path)
 
1903
    return (dirname(path) , path)
1968
1904
 
1969
1905
 
1970
1906
def compare_paths_prefix_order(path_a, path_b):
1971
1907
    """Compare path_a and path_b to generate the same order walkdirs uses."""
1972
1908
    key_a = path_prefix_key(path_a)
1973
1909
    key_b = path_prefix_key(path_b)
1974
 
    return (key_a > key_b) - (key_a < key_b)
 
1910
    return cmp(key_a, key_b)
1975
1911
 
1976
1912
 
1977
1913
_cached_user_encoding = None
1978
1914
 
1979
1915
 
1980
 
def get_user_encoding():
 
1916
def get_user_encoding(use_cache=True):
1981
1917
    """Find out what the preferred user encoding is.
1982
1918
 
1983
1919
    This is generally the encoding that is used for command line parameters
1984
1920
    and file contents. This may be different from the terminal encoding
1985
1921
    or the filesystem encoding.
1986
1922
 
 
1923
    :param  use_cache:  Enable cache for detected encoding.
 
1924
                        (This parameter is turned on by default,
 
1925
                        and required only for selftesting)
 
1926
 
1987
1927
    :return: A string defining the preferred user encoding
1988
1928
    """
1989
1929
    global _cached_user_encoding
1990
 
    if _cached_user_encoding is not None:
 
1930
    if _cached_user_encoding is not None and use_cache:
1991
1931
        return _cached_user_encoding
1992
1932
 
1993
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
1994
 
        # Use the existing locale settings and call nl_langinfo directly
1995
 
        # rather than going through getpreferredencoding. This avoids
1996
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
1997
 
        # possibility of the setlocale call throwing an error.
1998
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1933
    if sys.platform == 'darwin':
 
1934
        # python locale.getpreferredencoding() always return
 
1935
        # 'mac-roman' on darwin. That's a lie.
 
1936
        sys.platform = 'posix'
 
1937
        try:
 
1938
            if os.environ.get('LANG', None) is None:
 
1939
                # If LANG is not set, we end up with 'ascii', which is bad
 
1940
                # ('mac-roman' is more than ascii), so we set a default which
 
1941
                # will give us UTF-8 (which appears to work in all cases on
 
1942
                # OSX). Users are still free to override LANG of course, as
 
1943
                # long as it give us something meaningful. This work-around
 
1944
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1945
                # work with them too -- vila 20080908
 
1946
                os.environ['LANG'] = 'en_US.UTF-8'
 
1947
            import locale
 
1948
        finally:
 
1949
            sys.platform = 'darwin'
1999
1950
    else:
2000
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2001
 
        user_encoding = locale.getpreferredencoding(False)
 
1951
        import locale
2002
1952
 
2003
1953
    try:
2004
 
        user_encoding = codecs.lookup(user_encoding).name
2005
 
    except LookupError:
2006
 
        if user_encoding not in ("", "cp0"):
2007
 
            sys.stderr.write('brz: warning:'
 
1954
        user_encoding = locale.getpreferredencoding()
 
1955
    except locale.Error, e:
 
1956
        sys.stderr.write('bzr: warning: %s\n'
 
1957
                         '  Could not determine what text encoding to use.\n'
 
1958
                         '  This error usually means your Python interpreter\n'
 
1959
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1960
                         "  Continuing with ascii encoding.\n"
 
1961
                         % (e, os.environ.get('LANG')))
 
1962
        user_encoding = 'ascii'
 
1963
 
 
1964
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1965
    # treat that as ASCII, and not support printing unicode characters to the
 
1966
    # console.
 
1967
    #
 
1968
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1969
    if user_encoding in (None, 'cp0', ''):
 
1970
        user_encoding = 'ascii'
 
1971
    else:
 
1972
        # check encoding
 
1973
        try:
 
1974
            codecs.lookup(user_encoding)
 
1975
        except LookupError:
 
1976
            sys.stderr.write('bzr: warning:'
2008
1977
                             ' unknown encoding %s.'
2009
1978
                             ' Continuing with ascii encoding.\n'
2010
1979
                             % user_encoding
2011
 
                             )
2012
 
        user_encoding = 'ascii'
2013
 
    else:
2014
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2015
 
        if user_encoding == 'ascii':
2016
 
            if sys.platform == 'darwin':
2017
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2018
 
                # encoding and previously had LANG set here if not present.
2019
 
                user_encoding = 'utf-8'
2020
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2021
 
            #                for some other posix platforms as well.
2022
 
 
2023
 
    _cached_user_encoding = user_encoding
 
1980
                            )
 
1981
            user_encoding = 'ascii'
 
1982
 
 
1983
    if use_cache:
 
1984
        _cached_user_encoding = user_encoding
 
1985
 
2024
1986
    return user_encoding
2025
1987
 
2026
1988
 
2035
1997
    behaves inconsistently on different platforms.
2036
1998
    """
2037
1999
    if sys.platform == "win32":
 
2000
        import win32utils
2038
2001
        return win32utils.get_host_name()
2039
2002
    else:
2040
2003
        import socket
2041
 
        return socket.gethostname()
 
2004
        return socket.gethostname().decode(get_user_encoding())
2042
2005
 
2043
2006
 
2044
2007
# We must not read/write any more than 64k at a time from/to a socket so we
2047
2010
# data at once.
2048
2011
MAX_SOCKET_CHUNK = 64 * 1024
2049
2012
 
2050
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2013
_end_of_stream_errors = [errno.ECONNRESET]
2051
2014
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2052
2015
    _eno = getattr(errno, _eno, None)
2053
2016
    if _eno is not None:
2056
2019
 
2057
2020
 
2058
2021
def read_bytes_from_socket(sock, report_activity=None,
2059
 
                           max_read_size=MAX_SOCKET_CHUNK):
 
2022
        max_read_size=MAX_SOCKET_CHUNK):
2060
2023
    """Read up to max_read_size of bytes from sock and notify of progress.
2061
2024
 
2062
2025
    Translates "Connection reset by peer" into file-like EOF (return an
2063
2026
    empty string rather than raise an error), and repeats the recv if
2064
2027
    interrupted by a signal.
2065
2028
    """
2066
 
    while True:
 
2029
    while 1:
2067
2030
        try:
2068
 
            data = sock.recv(max_read_size)
2069
 
        except socket.error as e:
 
2031
            bytes = sock.recv(max_read_size)
 
2032
        except socket.error, e:
2070
2033
            eno = e.args[0]
2071
2034
            if eno in _end_of_stream_errors:
2072
2035
                # The connection was closed by the other side.  Callers expect
2073
2036
                # an empty string to signal end-of-stream.
2074
 
                return b""
 
2037
                return ""
2075
2038
            elif eno == errno.EINTR:
2076
2039
                # Retry the interrupted recv.
2077
2040
                continue
2078
2041
            raise
2079
2042
        else:
2080
2043
            if report_activity is not None:
2081
 
                report_activity(len(data), 'read')
2082
 
            return data
 
2044
                report_activity(len(bytes), 'read')
 
2045
            return bytes
2083
2046
 
2084
2047
 
2085
2048
def recv_all(socket, count):
2092
2055
 
2093
2056
    This isn't optimized and is intended mostly for use in testing.
2094
2057
    """
2095
 
    b = b''
 
2058
    b = ''
2096
2059
    while len(b) < count:
2097
2060
        new = read_bytes_from_socket(socket, None, count - len(b))
2098
 
        if new == b'':
2099
 
            break  # eof
 
2061
        if new == '':
 
2062
            break # eof
2100
2063
        b += new
2101
2064
    return b
2102
2065
 
2116
2079
    """
2117
2080
    sent_total = 0
2118
2081
    byte_count = len(bytes)
2119
 
    view = memoryview(bytes)
2120
2082
    while sent_total < byte_count:
2121
2083
        try:
2122
 
            sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
2123
 
        except (socket.error, IOError) as e:
2124
 
            if e.args[0] in _end_of_stream_errors:
2125
 
                raise errors.ConnectionReset(
2126
 
                    "Error trying to write to socket", e)
 
2084
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2085
        except socket.error, e:
2127
2086
            if e.args[0] != errno.EINTR:
2128
2087
                raise
2129
2088
        else:
2130
 
            if sent == 0:
2131
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2132
 
                                             % (sock,))
2133
2089
            sent_total += sent
2134
 
            if report_activity is not None:
2135
 
                report_activity(sent, 'write')
 
2090
            report_activity(sent, 'write')
2136
2091
 
2137
2092
 
2138
2093
def connect_socket(address):
2151
2106
            sock.connect(sa)
2152
2107
            return sock
2153
2108
 
2154
 
        except socket.error as e:
2155
 
            err = e
 
2109
        except socket.error, err:
2156
2110
            # 'err' is now the most recent error
2157
2111
            if sock is not None:
2158
2112
                sock.close()
2181
2135
def resource_string(package, resource_name):
2182
2136
    """Load a resource from a package and return it as a string.
2183
2137
 
2184
 
    Note: Only packages that start with breezy are currently supported.
 
2138
    Note: Only packages that start with bzrlib are currently supported.
2185
2139
 
2186
2140
    This is designed to be a lightweight implementation of resource
2187
2141
    loading in a way which is API compatible with the same API from
2190
2144
    If and when pkg_resources becomes a standard library, this routine
2191
2145
    can delegate to it.
2192
2146
    """
2193
 
    # Check package name is within breezy
2194
 
    if package == "breezy":
 
2147
    # Check package name is within bzrlib
 
2148
    if package == "bzrlib":
2195
2149
        resource_relpath = resource_name
2196
 
    elif package.startswith("breezy."):
2197
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2150
    elif package.startswith("bzrlib."):
 
2151
        package = package[len("bzrlib."):].replace('.', os.sep)
2198
2152
        resource_relpath = pathjoin(package, resource_name)
2199
2153
    else:
2200
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2154
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2201
2155
 
2202
2156
    # Map the resource to a file and read its contents
2203
 
    base = dirname(breezy.__file__)
 
2157
    base = dirname(bzrlib.__file__)
2204
2158
    if getattr(sys, 'frozen', None):    # bzr.exe
2205
2159
        base = abspath(pathjoin(base, '..', '..'))
2206
 
    with open(pathjoin(base, resource_relpath), "rt") as f:
 
2160
    f = file(pathjoin(base, resource_relpath), "rU")
 
2161
    try:
2207
2162
        return f.read()
2208
 
 
 
2163
    finally:
 
2164
        f.close()
2209
2165
 
2210
2166
def file_kind_from_stat_mode_thunk(mode):
2211
2167
    global file_kind_from_stat_mode
2212
2168
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2213
2169
        try:
2214
 
            from ._readdir_pyx import UTF8DirReader
 
2170
            from bzrlib._readdir_pyx import UTF8DirReader
2215
2171
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2216
 
        except ImportError:
 
2172
        except ImportError, e:
2217
2173
            # This is one time where we won't warn that an extension failed to
2218
2174
            # load. The extension is never available on Windows anyway.
2219
 
            from ._readdir_py import (
 
2175
            from bzrlib._readdir_py import (
2220
2176
                _kind_from_mode as file_kind_from_stat_mode
2221
2177
                )
2222
2178
    return file_kind_from_stat_mode(mode)
2223
 
 
2224
 
 
2225
2179
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2226
2180
 
2227
2181
 
2228
 
def file_stat(f, _lstat=os.lstat):
 
2182
def file_kind(f, _lstat=os.lstat):
2229
2183
    try:
2230
 
        # XXX cache?
2231
 
        return _lstat(f)
2232
 
    except OSError as e:
 
2184
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2185
    except OSError, e:
2233
2186
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2234
2187
            raise errors.NoSuchFile(f)
2235
2188
        raise
2236
2189
 
2237
2190
 
2238
 
def file_kind(f, _lstat=os.lstat):
2239
 
    stat_value = file_stat(f, _lstat)
2240
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2241
 
 
2242
 
 
2243
2191
def until_no_eintr(f, *a, **kw):
2244
2192
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2245
2193
 
2250
2198
    Keep in mind that this is not a complete solution to EINTR.  There is
2251
2199
    probably code in the Python standard library and other dependencies that
2252
2200
    may encounter EINTR if a signal arrives (and there is signal handler for
2253
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2201
    that signal).  So this function can reduce the impact for IO that bzrlib
2254
2202
    directly controls, but it is not a complete solution.
2255
2203
    """
2256
2204
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2257
2205
    while True:
2258
2206
        try:
2259
2207
            return f(*a, **kw)
2260
 
        except (IOError, OSError) as e:
 
2208
        except (IOError, OSError), e:
2261
2209
            if e.errno == errno.EINTR:
2262
2210
                continue
2263
2211
            raise
2264
2212
 
2265
2213
 
 
2214
@deprecated_function(deprecated_in((2, 2, 0)))
 
2215
def re_compile_checked(re_string, flags=0, where=""):
 
2216
    """Return a compiled re, or raise a sensible error.
 
2217
 
 
2218
    This should only be used when compiling user-supplied REs.
 
2219
 
 
2220
    :param re_string: Text form of regular expression.
 
2221
    :param flags: eg re.IGNORECASE
 
2222
    :param where: Message explaining to the user the context where
 
2223
        it occurred, eg 'log search filter'.
 
2224
    """
 
2225
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2226
    try:
 
2227
        re_obj = re.compile(re_string, flags)
 
2228
        re_obj.search("")
 
2229
        return re_obj
 
2230
    except errors.InvalidPattern, e:
 
2231
        if where:
 
2232
            where = ' in ' + where
 
2233
        # despite the name 'error' is a type
 
2234
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2235
            % (where, e.msg))
 
2236
 
 
2237
 
2266
2238
if sys.platform == "win32":
 
2239
    import msvcrt
2267
2240
    def getchar():
2268
 
        import msvcrt
2269
2241
        return msvcrt.getch()
2270
2242
else:
 
2243
    import tty
 
2244
    import termios
2271
2245
    def getchar():
2272
 
        import tty
2273
 
        import termios
2274
2246
        fd = sys.stdin.fileno()
2275
2247
        settings = termios.tcgetattr(fd)
2276
2248
        try:
2280
2252
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2281
2253
        return ch
2282
2254
 
2283
 
if sys.platform.startswith('linux'):
 
2255
if sys.platform == 'linux2':
2284
2256
    def _local_concurrency():
2285
2257
        try:
2286
2258
            return os.sysconf('SC_NPROCESSORS_ONLN')
2296
2268
                                stdout=subprocess.PIPE).communicate()[0]
2297
2269
elif sys.platform == 'sunos5':
2298
2270
    def _local_concurrency():
2299
 
        return subprocess.Popen(['psrinfo', '-p', ],
 
2271
        return subprocess.Popen(['psrinfo', '-p',],
2300
2272
                                stdout=subprocess.PIPE).communicate()[0]
2301
2273
elif sys.platform == "win32":
2302
2274
    def _local_concurrency():
2310
2282
 
2311
2283
_cached_local_concurrency = None
2312
2284
 
2313
 
 
2314
2285
def local_concurrency(use_cache=True):
2315
2286
    """Return how many processes can be run concurrently.
2316
2287
 
2322
2293
    if _cached_local_concurrency is not None and use_cache:
2323
2294
        return _cached_local_concurrency
2324
2295
 
2325
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2296
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2326
2297
    if concurrency is None:
2327
 
        import multiprocessing
2328
2298
        try:
 
2299
            import multiprocessing
 
2300
        except ImportError:
 
2301
            # multiprocessing is only available on Python >= 2.6
 
2302
            try:
 
2303
                concurrency = _local_concurrency()
 
2304
            except (OSError, IOError):
 
2305
                pass
 
2306
        else:
2329
2307
            concurrency = multiprocessing.cpu_count()
2330
 
        except NotImplementedError:
2331
 
            # multiprocessing.cpu_count() isn't implemented on all platforms
2332
 
            try:
2333
 
                concurrency = _local_concurrency()
2334
 
            except (OSError, IOError):
2335
 
                pass
2336
2308
    try:
2337
2309
        concurrency = int(concurrency)
2338
2310
    except (TypeError, ValueError):
2339
2311
        concurrency = 1
2340
2312
    if use_cache:
2341
 
        _cached_local_concurrency = concurrency
 
2313
        _cached_concurrency = concurrency
2342
2314
    return concurrency
2343
2315
 
2344
2316
 
2350
2322
        self.encode = encode
2351
2323
 
2352
2324
    def write(self, object):
2353
 
        if isinstance(object, str):
 
2325
        if type(object) is str:
2354
2326
            self.stream.write(object)
2355
2327
        else:
2356
2328
            data, _ = self.encode(object, self.errors)
2357
2329
            self.stream.write(data)
2358
2330
 
2359
 
 
2360
2331
if sys.platform == 'win32':
2361
2332
    def open_file(filename, mode='r', bufsize=-1):
2362
2333
        """This function is used to override the ``open`` builtin.
2390
2361
            else:
2391
2362
                flags |= os.O_WRONLY
2392
2363
            flags |= os.O_CREAT | os.O_APPEND
2393
 
        else:  # reading
 
2364
        else: #reading
2394
2365
            if updating:
2395
2366
                flags |= os.O_RDWR
2396
2367
            else:
2401
2372
    open_file = open
2402
2373
 
2403
2374
 
 
2375
def getuser_unicode():
 
2376
    """Return the username as unicode.
 
2377
    """
 
2378
    try:
 
2379
        user_encoding = get_user_encoding()
 
2380
        username = getpass.getuser().decode(user_encoding)
 
2381
    except UnicodeDecodeError:
 
2382
        raise errors.BzrError("Can't decode username as %s." % \
 
2383
                user_encoding)
 
2384
    return username
 
2385
 
 
2386
 
2404
2387
def available_backup_name(base, exists):
2405
2388
    """Find a non-existing backup file name.
2406
2389
 
2436
2419
 
2437
2420
def find_executable_on_path(name):
2438
2421
    """Finds an executable on the PATH.
2439
 
 
 
2422
    
2440
2423
    On Windows, this will try to append each extension in the PATHEXT
2441
2424
    environment variable to the name, if it cannot be found with the name
2442
2425
    as given.
2443
 
 
 
2426
    
2444
2427
    :param name: The base name of the executable.
2445
2428
    :return: The path to the executable found or None.
2446
2429
    """
 
2430
    path = os.environ.get('PATH')
 
2431
    if path is None:
 
2432
        return None
 
2433
    path = path.split(os.pathsep)
2447
2434
    if sys.platform == 'win32':
2448
2435
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2449
2436
        exts = [ext.lower() for ext in exts]
2455
2442
            exts = [ext]
2456
2443
    else:
2457
2444
        exts = ['']
2458
 
    path = os.environ.get('PATH')
2459
 
    if path is not None:
2460
 
        path = path.split(os.pathsep)
2461
 
        for ext in exts:
2462
 
            for d in path:
2463
 
                f = os.path.join(d, name) + ext
2464
 
                if os.access(f, os.X_OK):
2465
 
                    return f
2466
 
    if sys.platform == 'win32':
2467
 
        app_path = win32utils.get_app_path(name)
2468
 
        if app_path != name:
2469
 
            return app_path
 
2445
    for ext in exts:
 
2446
        for d in path:
 
2447
            f = os.path.join(d, name) + ext
 
2448
            if os.access(f, os.X_OK):
 
2449
                return f
2470
2450
    return None
2471
 
 
2472
 
 
2473
 
def _posix_is_local_pid_dead(pid):
2474
 
    """True if pid doesn't correspond to live process on this machine"""
2475
 
    try:
2476
 
        # Special meaning of unix kill: just check if it's there.
2477
 
        os.kill(pid, 0)
2478
 
    except OSError as e:
2479
 
        if e.errno == errno.ESRCH:
2480
 
            # On this machine, and really not found: as sure as we can be
2481
 
            # that it's dead.
2482
 
            return True
2483
 
        elif e.errno == errno.EPERM:
2484
 
            # exists, though not ours
2485
 
            return False
2486
 
        else:
2487
 
            trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2488
 
            # Don't really know.
2489
 
            return False
2490
 
    else:
2491
 
        # Exists and our process: not dead.
2492
 
        return False
2493
 
 
2494
 
 
2495
 
if sys.platform == "win32":
2496
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2497
 
else:
2498
 
    is_local_pid_dead = _posix_is_local_pid_dead
2499
 
 
2500
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2501
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2502
 
                      if getattr(errno, name, None) is not None]
2503
 
 
2504
 
 
2505
 
def fdatasync(fileno):
2506
 
    """Flush file contents to disk if possible.
2507
 
 
2508
 
    :param fileno: Integer OS file handle.
2509
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2510
 
    """
2511
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2512
 
    if fn is not None:
2513
 
        try:
2514
 
            fn(fileno)
2515
 
        except IOError as e:
2516
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2517
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2518
 
            # and reduce the chance of corruption-on-powerloss situations. It
2519
 
            # is not a mandatory call, so it is ok to suppress failures.
2520
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2521
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2522
 
                raise
2523
 
 
2524
 
 
2525
 
def ensure_empty_directory_exists(path, exception_class):
2526
 
    """Make sure a local directory exists and is empty.
2527
 
 
2528
 
    If it does not exist, it is created.  If it exists and is not empty, an
2529
 
    instance of exception_class is raised.
2530
 
    """
2531
 
    try:
2532
 
        os.mkdir(path)
2533
 
    except OSError as e:
2534
 
        if e.errno != errno.EEXIST:
2535
 
            raise
2536
 
        if os.listdir(path) != []:
2537
 
            raise exception_class(path)
2538
 
 
2539
 
 
2540
 
def read_mtab(path):
2541
 
    """Read an fstab-style file and extract mountpoint+filesystem information.
2542
 
 
2543
 
    :param path: Path to read from
2544
 
    :yield: Tuples with mountpoints (as bytestrings) and filesystem names
2545
 
    """
2546
 
    with open(path, 'rb') as f:
2547
 
        for line in f:
2548
 
            if line.startswith(b'#'):
2549
 
                continue
2550
 
            cols = line.split()
2551
 
            if len(cols) < 3:
2552
 
                continue
2553
 
            yield cols[1], cols[2].decode('ascii', 'replace')
2554
 
 
2555
 
 
2556
 
MTAB_PATH = '/etc/mtab'
2557
 
 
2558
 
class FilesystemFinder(object):
2559
 
    """Find the filesystem for a particular path."""
2560
 
 
2561
 
    def __init__(self, mountpoints):
2562
 
        def key(x):
2563
 
            return len(x[0])
2564
 
        self._mountpoints = sorted(mountpoints, key=key, reverse=True)
2565
 
 
2566
 
    @classmethod
2567
 
    def from_mtab(cls):
2568
 
        """Create a FilesystemFinder from an mtab-style file.
2569
 
 
2570
 
        Note that this will silenty ignore mtab if it doesn't exist or can not
2571
 
        be opened.
2572
 
        """
2573
 
        # TODO(jelmer): Use inotify to be notified when /etc/mtab changes and
2574
 
        # we need to re-read it.
2575
 
        try:
2576
 
            return cls(read_mtab(MTAB_PATH))
2577
 
        except EnvironmentError as e:
2578
 
            trace.mutter('Unable to read mtab: %s', e)
2579
 
            return cls([])
2580
 
 
2581
 
    def find(self, path):
2582
 
        """Find the filesystem used by a particular path.
2583
 
 
2584
 
        :param path: Path to find (bytestring or text type)
2585
 
        :return: Filesystem name (as text type) or None, if the filesystem is
2586
 
            unknown.
2587
 
        """
2588
 
        for mountpoint, filesystem in self._mountpoints:
2589
 
            if is_inside(mountpoint, path):
2590
 
                return filesystem
2591
 
        return None
2592
 
 
2593
 
 
2594
 
_FILESYSTEM_FINDER = None
2595
 
 
2596
 
 
2597
 
def get_fs_type(path):
2598
 
    """Return the filesystem type for the partition a path is in.
2599
 
 
2600
 
    :param path: Path to search filesystem type for
2601
 
    :return: A FS type, as string. E.g. "ext2"
2602
 
    """
2603
 
    global _FILESYSTEM_FINDER
2604
 
    if _FILESYSTEM_FINDER is None:
2605
 
        _FILESYSTEM_FINDER = FilesystemFinder.from_mtab()
2606
 
 
2607
 
    if not isinstance(path, bytes):
2608
 
        path = path.encode(_fs_enc)
2609
 
 
2610
 
    return _FILESYSTEM_FINDER.find(path)
2611
 
 
2612
 
 
2613
 
perf_counter = time.perf_counter