/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: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import errno
20
17
import os
21
18
import re
22
19
import stat
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
22
import sys
24
23
import time
25
24
import codecs
 
25
import warnings
26
26
 
27
 
from .lazy_import import lazy_import
 
27
from bzrlib.lazy_import import lazy_import
28
28
lazy_import(globals(), """
29
29
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
30
import errno
 
31
from ntpath import (abspath as _nt_abspath,
 
32
                    join as _nt_join,
 
33
                    normpath as _nt_normpath,
 
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
 
36
                    )
33
37
import posixpath
34
 
import select
35
 
# We need to import both shutil and rmtree as we export the later on posix
36
 
# and need the former on windows
37
38
import shutil
38
 
from shutil import rmtree
 
39
from shutil import (
 
40
    rmtree,
 
41
    )
 
42
import signal
39
43
import socket
40
44
import subprocess
41
 
# We need to import both tempfile and mkdtemp as we export the later on posix
42
 
# and need the former on windows
43
45
import tempfile
44
 
from tempfile import mkdtemp
 
46
from tempfile import (
 
47
    mkdtemp,
 
48
    )
45
49
import unicodedata
46
50
 
47
 
from breezy import (
48
 
    config,
 
51
from bzrlib import (
 
52
    cache_utf8,
 
53
    errors,
49
54
    trace,
50
55
    win32utils,
51
56
    )
52
 
from breezy.i18n import gettext
53
57
""")
54
58
 
55
 
from .sixish import (
56
 
    PY3,
57
 
    text_type,
58
 
    )
59
 
 
60
 
from hashlib import (
61
 
    md5,
62
 
    sha1 as sha,
63
 
    )
64
 
 
65
 
 
66
 
import breezy
67
 
from . import (
68
 
    _fs_enc,
69
 
    errors,
70
 
    )
 
59
from bzrlib.symbol_versioning import (
 
60
    deprecated_function,
 
61
    deprecated_in,
 
62
    )
 
63
 
 
64
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
65
# of 2.5
 
66
if sys.version_info < (2, 5):
 
67
    import md5 as _mod_md5
 
68
    md5 = _mod_md5.new
 
69
    import sha as _mod_sha
 
70
    sha = _mod_sha.new
 
71
else:
 
72
    from hashlib import (
 
73
        md5,
 
74
        sha1 as sha,
 
75
        )
 
76
 
 
77
 
 
78
import bzrlib
 
79
from bzrlib import symbol_versioning
71
80
 
72
81
 
73
82
# Cross platform wall-clock time functionality with decent resolution.
90
99
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
91
100
 
92
101
 
93
 
class UnsupportedTimezoneFormat(errors.BzrError):
94
 
 
95
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
96
 
            'options are "utc", "original", "local".')
97
 
 
98
 
    def __init__(self, timezone):
99
 
        self.timezone = timezone
100
 
 
101
 
 
102
102
def get_unicode_argv():
103
 
    if PY3:
104
 
        return sys.argv[1:]
105
103
    try:
106
104
        user_encoding = get_user_encoding()
107
105
        return [a.decode(user_encoding) for a in sys.argv[1:]]
108
106
    except UnicodeDecodeError:
109
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
 
            "application locale.").format(a, user_encoding))
 
107
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
108
                                                            "encoding." % a))
111
109
 
112
110
 
113
111
def make_readonly(filename):
114
112
    """Make a filename read-only."""
115
113
    mod = os.lstat(filename).st_mode
116
114
    if not stat.S_ISLNK(mod):
117
 
        mod = mod & 0o777555
118
 
        chmod_if_possible(filename, mod)
 
115
        mod = mod & 0777555
 
116
        os.chmod(filename, mod)
119
117
 
120
118
 
121
119
def make_writable(filename):
122
120
    mod = os.lstat(filename).st_mode
123
121
    if not stat.S_ISLNK(mod):
124
 
        mod = mod | 0o200
125
 
        chmod_if_possible(filename, mod)
126
 
 
127
 
 
128
 
def chmod_if_possible(filename, mode):
129
 
    # Set file mode if that can be safely done.
130
 
    # Sometimes even on unix the filesystem won't allow it - see
131
 
    # https://bugs.launchpad.net/bzr/+bug/606537
132
 
    try:
133
 
        # It is probably faster to just do the chmod, rather than
134
 
        # doing a stat, and then trying to compare
135
 
        os.chmod(filename, mode)
136
 
    except (IOError, OSError) as e:
137
 
        # Permission/access denied seems to commonly happen on smbfs; there's
138
 
        # probably no point warning about it.
139
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
140
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
141
 
            trace.mutter("ignore error on chmod of %r: %r" % (
142
 
                filename, e))
143
 
            return
144
 
        raise
 
122
        mod = mod | 0200
 
123
        os.chmod(filename, mod)
145
124
 
146
125
 
147
126
def minimum_path_selection(paths):
222
201
            stat = getattr(os, 'lstat', os.stat)
223
202
            stat(f)
224
203
            return True
225
 
        except OSError as e:
 
204
        except OSError, e:
226
205
            if e.errno == errno.ENOENT:
227
206
                return False;
228
207
            else:
229
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
208
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
230
209
 
231
210
 
232
211
def fancy_rename(old, new, rename_func, unlink_func):
256
235
    file_existed = False
257
236
    try:
258
237
        rename_func(new, tmp_name)
259
 
    except (errors.NoSuchFile,) as e:
 
238
    except (errors.NoSuchFile,), e:
260
239
        pass
261
 
    except IOError as e:
 
240
    except IOError, e:
262
241
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
263
242
        # function raises an IOError with errno is None when a rename fails.
264
243
        # This then gets caught here.
265
244
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
266
245
            raise
267
 
    except Exception as e:
 
246
    except Exception, e:
268
247
        if (getattr(e, 'errno', None) is None
269
248
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
270
249
            raise
271
250
    else:
272
251
        file_existed = True
273
252
 
 
253
    failure_exc = None
274
254
    success = False
275
255
    try:
276
 
        # This may throw an exception, in which case success will
277
 
        # not be set.
278
 
        rename_func(old, new)
279
 
        success = True
280
 
    except (IOError, OSError) as e:
281
 
        # source and target may be aliases of each other (e.g. on a
282
 
        # case-insensitive filesystem), so we may have accidentally renamed
283
 
        # source by when we tried to rename target
284
 
        if (file_existed and e.errno in (None, errno.ENOENT)
285
 
            and old.lower() == new.lower()):
286
 
            # source and target are the same file on a case-insensitive
287
 
            # filesystem, so we don't generate an exception
288
 
            pass
289
 
        else:
290
 
            raise
 
256
        try:
 
257
            # This may throw an exception, in which case success will
 
258
            # not be set.
 
259
            rename_func(old, new)
 
260
            success = True
 
261
        except (IOError, OSError), e:
 
262
            # source and target may be aliases of each other (e.g. on a
 
263
            # case-insensitive filesystem), so we may have accidentally renamed
 
264
            # source by when we tried to rename target
 
265
            failure_exc = sys.exc_info()
 
266
            if (file_existed and e.errno in (None, errno.ENOENT)
 
267
                and old.lower() == new.lower()):
 
268
                # source and target are the same file on a case-insensitive
 
269
                # filesystem, so we don't generate an exception
 
270
                failure_exc = None
291
271
    finally:
292
272
        if file_existed:
293
273
            # If the file used to exist, rename it back into place
296
276
                unlink_func(tmp_name)
297
277
            else:
298
278
                rename_func(tmp_name, new)
 
279
    if failure_exc is not None:
 
280
        raise failure_exc[0], failure_exc[1], failure_exc[2]
299
281
 
300
282
 
301
283
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
302
284
# choke on a Unicode string containing a relative path if
303
285
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
304
286
# string.
 
287
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
305
288
def _posix_abspath(path):
306
289
    # jam 20060426 rather than encoding to fsencoding
307
290
    # copy posixpath.abspath, but use os.getcwdu instead
308
291
    if not posixpath.isabs(path):
309
292
        path = posixpath.join(getcwd(), path)
310
 
    return _posix_normpath(path)
 
293
    return posixpath.normpath(path)
311
294
 
312
295
 
313
296
def _posix_realpath(path):
314
297
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
315
298
 
316
299
 
317
 
def _posix_normpath(path):
318
 
    path = posixpath.normpath(path)
319
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
320
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
321
 
    # leading slashes must not be simplified to one, and only if there are 3 or
322
 
    # more should they be simplified as one. So we treat the leading 2 slashes
323
 
    # as a special case here by simply removing the first slash, as we consider
324
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
325
 
    # This is not a paranoid precaution, as we notably get paths like this when
326
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
327
 
    if path.startswith('//'):
328
 
        path = path[1:]
329
 
    return path
330
 
 
331
 
 
332
 
def _posix_path_from_environ(key):
333
 
    """Get unicode path from `key` in environment or None if not present
334
 
 
335
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
336
 
    so a path that raises BadFilenameEncoding here may still be accessible.
337
 
    """
338
 
    val = os.environ.get(key, None)
339
 
    if PY3 or val is None:
340
 
        return val
341
 
    try:
342
 
        return val.decode(_fs_enc)
343
 
    except UnicodeDecodeError:
344
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
345
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
346
 
 
347
 
 
348
 
def _posix_get_home_dir():
349
 
    """Get the home directory of the current user as a unicode path"""
350
 
    path = posixpath.expanduser("~")
351
 
    try:
352
 
        return path.decode(_fs_enc)
353
 
    except AttributeError:
354
 
        return path
355
 
    except UnicodeDecodeError:
356
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
357
 
 
358
 
 
359
 
def _posix_getuser_unicode():
360
 
    """Get username from environment or password database as unicode"""
361
 
    name = getpass.getuser()
362
 
    if PY3:
363
 
        return name
364
 
    user_encoding = get_user_encoding()
365
 
    try:
366
 
        return name.decode(user_encoding)
367
 
    except UnicodeDecodeError:
368
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
369
 
            "application locale." % (name, user_encoding))
370
 
 
371
 
 
372
300
def _win32_fixdrive(path):
373
301
    """Force drive letters to be consistent.
374
302
 
378
306
    running python.exe under cmd.exe return capital C:\\
379
307
    running win32 python inside a cygwin shell returns lowercase c:\\
380
308
    """
381
 
    drive, path = ntpath.splitdrive(path)
 
309
    drive, path = _nt_splitdrive(path)
382
310
    return drive.upper() + path
383
311
 
384
312
 
385
313
def _win32_abspath(path):
386
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
387
 
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
 
314
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
315
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
316
 
 
317
 
 
318
def _win98_abspath(path):
 
319
    """Return the absolute version of a path.
 
320
    Windows 98 safe implementation (python reimplementation
 
321
    of Win32 API function GetFullPathNameW)
 
322
    """
 
323
    # Corner cases:
 
324
    #   C:\path     => C:/path
 
325
    #   C:/path     => C:/path
 
326
    #   \\HOST\path => //HOST/path
 
327
    #   //HOST/path => //HOST/path
 
328
    #   path        => C:/cwd/path
 
329
    #   /path       => C:/path
 
330
    path = unicode(path)
 
331
    # check for absolute path
 
332
    drive = _nt_splitdrive(path)[0]
 
333
    if drive == '' and path[:2] not in('//','\\\\'):
 
334
        cwd = os.getcwdu()
 
335
        # we cannot simply os.path.join cwd and path
 
336
        # because os.path.join('C:','/path') produce '/path'
 
337
        # and this is incorrect
 
338
        if path[:1] in ('/','\\'):
 
339
            cwd = _nt_splitdrive(cwd)[0]
 
340
            path = path[1:]
 
341
        path = cwd + '\\' + path
 
342
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
388
343
 
389
344
 
390
345
def _win32_realpath(path):
391
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
392
 
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
 
346
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
347
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
393
348
 
394
349
 
395
350
def _win32_pathjoin(*args):
396
 
    return ntpath.join(*args).replace('\\', '/')
 
351
    return _nt_join(*args).replace('\\', '/')
397
352
 
398
353
 
399
354
def _win32_normpath(path):
400
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
355
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
401
356
 
402
357
 
403
358
def _win32_getcwd():
404
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
359
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
405
360
 
406
361
 
407
362
def _win32_mkdtemp(*args, **kwargs):
416
371
    """
417
372
    try:
418
373
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
419
 
    except OSError as e:
 
374
    except OSError, e:
420
375
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
421
376
            # If we try to rename a non-existant file onto cwd, we get
422
377
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
427
382
 
428
383
 
429
384
def _mac_getcwd():
430
 
    return unicodedata.normalize('NFC', _getcwd())
431
 
 
432
 
 
433
 
def _rename_wrap_exception(rename_func):
434
 
    """Adds extra information to any exceptions that come from rename().
435
 
 
436
 
    The exception has an updated message and 'old_filename' and 'new_filename'
437
 
    attributes.
438
 
    """
439
 
 
440
 
    def _rename_wrapper(old, new):
441
 
        try:
442
 
            rename_func(old, new)
443
 
        except OSError as e:
444
 
            detailed_error = OSError(e.errno, e.strerror +
445
 
                                " [occurred when renaming '%s' to '%s']" %
446
 
                                (old, new))
447
 
            detailed_error.old_filename = old
448
 
            detailed_error.new_filename = new
449
 
            raise detailed_error
450
 
 
451
 
    return _rename_wrapper
452
 
 
453
 
 
454
 
if sys.version_info > (3,):
455
 
    _getcwd = os.getcwd
456
 
else:
457
 
    _getcwd = os.getcwdu
458
 
 
459
 
 
460
 
# Default rename wraps os.rename()
461
 
rename = _rename_wrap_exception(os.rename)
 
385
    return unicodedata.normalize('NFC', os.getcwdu())
 
386
 
462
387
 
463
388
# Default is to just use the python builtins, but these can be rebound on
464
389
# particular platforms.
465
390
abspath = _posix_abspath
466
391
realpath = _posix_realpath
467
392
pathjoin = os.path.join
468
 
normpath = _posix_normpath
469
 
path_from_environ = _posix_path_from_environ
470
 
_get_home_dir = _posix_get_home_dir
471
 
getuser_unicode = _posix_getuser_unicode
472
 
getcwd = _getcwd
 
393
normpath = os.path.normpath
 
394
getcwd = os.getcwdu
 
395
rename = os.rename
473
396
dirname = os.path.dirname
474
397
basename = os.path.basename
475
398
split = os.path.split
476
399
splitext = os.path.splitext
477
 
# These were already lazily imported into local scope
 
400
# These were already imported into local scope
478
401
# mkdtemp = tempfile.mkdtemp
479
402
# rmtree = shutil.rmtree
480
 
lstat = os.lstat
481
 
fstat = os.fstat
482
 
 
483
 
def wrap_stat(st):
484
 
    return st
485
 
 
486
403
 
487
404
MIN_ABS_PATHLENGTH = 1
488
405
 
489
406
 
490
407
if sys.platform == 'win32':
491
 
    abspath = _win32_abspath
 
408
    if win32utils.winver == 'Windows 98':
 
409
        abspath = _win98_abspath
 
410
    else:
 
411
        abspath = _win32_abspath
492
412
    realpath = _win32_realpath
493
413
    pathjoin = _win32_pathjoin
494
414
    normpath = _win32_normpath
495
415
    getcwd = _win32_getcwd
496
416
    mkdtemp = _win32_mkdtemp
497
 
    rename = _rename_wrap_exception(_win32_rename)
498
 
    try:
499
 
        from . import _walkdirs_win32
500
 
    except ImportError:
501
 
        pass
502
 
    else:
503
 
        lstat = _walkdirs_win32.lstat
504
 
        fstat = _walkdirs_win32.fstat
505
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
417
    rename = _win32_rename
506
418
 
507
419
    MIN_ABS_PATHLENGTH = 3
508
420
 
526
438
    f = win32utils.get_unicode_argv     # special function or None
527
439
    if f is not None:
528
440
        get_unicode_argv = f
529
 
    path_from_environ = win32utils.get_environ_unicode
530
 
    _get_home_dir = win32utils.get_home_location
531
 
    getuser_unicode = win32utils.get_user_name
532
441
 
533
442
elif sys.platform == 'darwin':
534
443
    getcwd = _mac_getcwd
535
444
 
536
445
 
537
 
def get_terminal_encoding(trace=False):
 
446
def get_terminal_encoding():
538
447
    """Find the best encoding for printing to the screen.
539
448
 
540
449
    This attempts to check both sys.stdout and sys.stdin to see
546
455
 
547
456
    On my standard US Windows XP, the preferred encoding is
548
457
    cp1252, but the console is cp437
549
 
 
550
 
    :param trace: If True trace the selected encoding via mutter().
551
458
    """
552
 
    from .trace import mutter
 
459
    from bzrlib.trace import mutter
553
460
    output_encoding = getattr(sys.stdout, 'encoding', None)
554
461
    if not output_encoding:
555
462
        input_encoding = getattr(sys.stdin, 'encoding', None)
556
463
        if not input_encoding:
557
464
            output_encoding = get_user_encoding()
558
 
            if trace:
559
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
465
            mutter('encoding stdout as osutils.get_user_encoding() %r',
560
466
                   output_encoding)
561
467
        else:
562
468
            output_encoding = input_encoding
563
 
            if trace:
564
 
                mutter('encoding stdout as sys.stdin encoding %r',
565
 
                    output_encoding)
 
469
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
566
470
    else:
567
 
        if trace:
568
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
471
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
569
472
    if output_encoding == 'cp0':
570
473
        # invalid encoding (cp0 means 'no codepage' on Windows)
571
474
        output_encoding = get_user_encoding()
572
 
        if trace:
573
 
            mutter('cp0 is invalid encoding.'
 
475
        mutter('cp0 is invalid encoding.'
574
476
               ' encoding stdout as osutils.get_user_encoding() %r',
575
477
               output_encoding)
576
478
    # check encoding
577
479
    try:
578
480
        codecs.lookup(output_encoding)
579
481
    except LookupError:
580
 
        sys.stderr.write('brz: warning:'
 
482
        sys.stderr.write('bzr: warning:'
581
483
                         ' unknown terminal encoding %s.\n'
582
484
                         '  Using encoding %s instead.\n'
583
485
                         % (output_encoding, get_user_encoding())
592
494
        F = realpath
593
495
    else:
594
496
        F = abspath
595
 
    [p, e] = os.path.split(f)
 
497
    [p,e] = os.path.split(f)
596
498
    if e == "" or e == "." or e == "..":
597
499
        return F(f)
598
500
    else:
602
504
def isdir(f):
603
505
    """True if f is an accessible directory."""
604
506
    try:
605
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
507
        return S_ISDIR(os.lstat(f)[ST_MODE])
606
508
    except OSError:
607
509
        return False
608
510
 
610
512
def isfile(f):
611
513
    """True if f is a regular file."""
612
514
    try:
613
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
515
        return S_ISREG(os.lstat(f)[ST_MODE])
614
516
    except OSError:
615
517
        return False
616
518
 
617
519
def islink(f):
618
520
    """True if f is a symlink."""
619
521
    try:
620
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISLNK(os.lstat(f)[ST_MODE])
621
523
    except OSError:
622
524
        return False
623
525
 
639
541
    if dir == '':
640
542
        return True
641
543
 
642
 
    if not dir.endswith('/'):
 
544
    if dir[-1] != '/':
643
545
        dir += '/'
644
546
 
645
547
    return fname.startswith(dir)
720
622
    # drives).
721
623
    if not segment_size:
722
624
        segment_size = 5242880 # 5MB
723
 
    offsets = range(0, len(bytes), segment_size)
724
 
    view = memoryview(bytes)
 
625
    segments = range(len(bytes) / segment_size + 1)
725
626
    write = file_handle.write
726
 
    for offset in offsets:
727
 
        write(view[offset:offset+segment_size])
 
627
    for segment_index in segments:
 
628
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
629
        write(segment)
728
630
 
729
631
 
730
632
def file_iterator(input_file, readsize=32768):
735
637
        yield b
736
638
 
737
639
 
738
 
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
739
 
# used as bytes through most interfaces so encode with this wrapper.
740
 
if PY3:
741
 
    def _hexdigest(hashobj):
742
 
        return hashobj.hexdigest().encode()
743
 
else:
744
 
    def _hexdigest(hashobj):
745
 
        return hashobj.hexdigest()
746
 
 
747
 
 
748
640
def sha_file(f):
749
641
    """Calculate the hexdigest of an open file.
750
642
 
757
649
        if not b:
758
650
            break
759
651
        s.update(b)
760
 
    return _hexdigest(s)
 
652
    return s.hexdigest()
761
653
 
762
654
 
763
655
def size_sha_file(f):
775
667
            break
776
668
        size += len(b)
777
669
        s.update(b)
778
 
    return size, _hexdigest(s)
 
670
    return size, s.hexdigest()
779
671
 
780
672
 
781
673
def sha_file_by_name(fname):
786
678
        while True:
787
679
            b = os.read(f, 1<<16)
788
680
            if not b:
789
 
                return _hexdigest(s)
 
681
                return s.hexdigest()
790
682
            s.update(b)
791
683
    finally:
792
684
        os.close(f)
795
687
def sha_strings(strings, _factory=sha):
796
688
    """Return the sha-1 of concatenation of strings"""
797
689
    s = _factory()
798
 
    for string in strings:
799
 
        s.update(string)
800
 
    return _hexdigest(s)
 
690
    map(s.update, strings)
 
691
    return s.hexdigest()
801
692
 
802
693
 
803
694
def sha_string(f, _factory=sha):
804
 
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
805
 
    return _hexdigest(_factory(f))
 
695
    return _factory(f).hexdigest()
806
696
 
807
697
 
808
698
def fingerprint_file(f):
809
699
    b = f.read()
810
700
    return {'size': len(b),
811
 
            'sha1': _hexdigest(sha(b))}
 
701
            'sha1': sha(b).hexdigest()}
812
702
 
813
703
 
814
704
def compare_files(a, b):
819
709
        bi = b.read(BUFSIZE)
820
710
        if ai != bi:
821
711
            return False
822
 
        if not ai:
 
712
        if ai == '':
823
713
            return True
824
714
 
825
715
 
893
783
    (date_fmt, tt, offset_str) = \
894
784
               _format_date(t, offset, timezone, date_fmt, show_offset)
895
785
    date_str = time.strftime(date_fmt, tt)
896
 
    if not isinstance(date_str, text_type):
 
786
    if not isinstance(date_str, unicode):
897
787
        date_str = date_str.decode(get_user_encoding(), 'replace')
898
788
    return date_str + offset_str
899
789
 
910
800
        tt = time.localtime(t)
911
801
        offset = local_time_offset(t)
912
802
    else:
913
 
        raise UnsupportedTimezoneFormat(timezone)
 
803
        raise errors.UnsupportedTimezoneFormat(timezone)
914
804
    if date_fmt is None:
915
805
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
916
806
    if show_offset:
975
865
 
976
866
def filesize(f):
977
867
    """Return size of given open file."""
978
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
979
 
 
980
 
 
981
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
982
 
# override if it doesn't work. Avoid checking on windows where there is
983
 
# significant initialisation cost that can be avoided for some bzr calls.
984
 
 
985
 
rand_bytes = os.urandom
986
 
 
987
 
if rand_bytes.__module__ != "nt":
 
868
    return os.fstat(f.fileno())[ST_SIZE]
 
869
 
 
870
 
 
871
# Define rand_bytes based on platform.
 
872
try:
 
873
    # Python 2.4 and later have os.urandom,
 
874
    # but it doesn't work on some arches
 
875
    os.urandom(1)
 
876
    rand_bytes = os.urandom
 
877
except (NotImplementedError, AttributeError):
 
878
    # If python doesn't have os.urandom, or it doesn't work,
 
879
    # then try to first pull random data from /dev/urandom
988
880
    try:
989
 
        rand_bytes(1)
990
 
    except NotImplementedError:
 
881
        rand_bytes = file('/dev/urandom', 'rb').read
 
882
    # Otherwise, use this hack as a last resort
 
883
    except (IOError, OSError):
991
884
        # not well seeded, but better than nothing
992
885
        def rand_bytes(n):
993
886
            import random
1007
900
    """
1008
901
    s = ''
1009
902
    for raw_byte in rand_bytes(num):
1010
 
        if not PY3:
1011
 
            s += ALNUM[ord(raw_byte) % 36]
1012
 
        else:
1013
 
            s += ALNUM[raw_byte % 36]
 
903
        s += ALNUM[ord(raw_byte) % 36]
1014
904
    return s
1015
905
 
1016
906
 
1026
916
    rps = []
1027
917
    for f in ps:
1028
918
        if f == '..':
1029
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
919
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1030
920
        elif (f == '.') or (f == ''):
1031
921
            pass
1032
922
        else:
1037
927
def joinpath(p):
1038
928
    for f in p:
1039
929
        if (f == '..') or (f is None) or (f == ''):
1040
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
930
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1041
931
    return pathjoin(*p)
1042
932
 
1043
933
 
1044
934
def parent_directories(filename):
1045
935
    """Return the list of parent directories, deepest first.
1046
 
 
 
936
    
1047
937
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1048
938
    """
1049
939
    parents = []
1065
955
    implementation should be loaded instead::
1066
956
 
1067
957
    >>> try:
1068
 
    >>>     import breezy._fictional_extension_pyx
 
958
    >>>     import bzrlib._fictional_extension_pyx
1069
959
    >>> except ImportError, e:
1070
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1071
 
    >>>     import breezy._fictional_extension_py
 
960
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
961
    >>>     import bzrlib._fictional_extension_py
1072
962
    """
1073
963
    # NB: This docstring is just an example, not a doctest, because doctest
1074
964
    # currently can't cope with the use of lazy imports in this namespace --
1075
965
    # mbp 20090729
1076
 
 
 
966
    
1077
967
    # This currently doesn't report the failure at the time it occurs, because
1078
968
    # they tend to happen very early in startup when we can't check config
1079
969
    # files etc, and also we want to report all failures but not spam the user
1080
970
    # with 10 warnings.
 
971
    from bzrlib import trace
1081
972
    exception_str = str(exception)
1082
973
    if exception_str not in _extension_load_failures:
1083
974
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1087
978
def report_extension_load_failures():
1088
979
    if not _extension_load_failures:
1089
980
        return
1090
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
981
    from bzrlib.config import GlobalConfig
 
982
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1091
983
        return
1092
984
    # the warnings framework should by default show this only once
1093
 
    from .trace import warning
 
985
    from bzrlib.trace import warning
1094
986
    warning(
1095
 
        "brz: warning: some compiled extensions could not be loaded; "
1096
 
        "see ``brz help missing-extensions``")
 
987
        "bzr: warning: some compiled extensions could not be loaded; "
 
988
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1097
989
    # we no longer show the specific missing extensions here, because it makes
1098
990
    # the message too long and scary - see
1099
991
    # https://bugs.launchpad.net/bzr/+bug/430529
1100
992
 
1101
993
 
1102
994
try:
1103
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1104
 
except ImportError as e:
 
995
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
996
except ImportError, e:
1105
997
    failed_to_load_extension(e)
1106
 
    from ._chunks_to_lines_py import chunks_to_lines
 
998
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1107
999
 
1108
1000
 
1109
1001
def split_lines(s):
1122
1014
 
1123
1015
    This supports Unicode or plain string objects.
1124
1016
    """
1125
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1126
 
    lines = s.split(nl)
1127
 
    result = [line + nl for line in lines[:-1]]
 
1017
    lines = s.split('\n')
 
1018
    result = [line + '\n' for line in lines[:-1]]
1128
1019
    if lines[-1]:
1129
1020
        result.append(lines[-1])
1130
1021
    return result
1141
1032
        return
1142
1033
    try:
1143
1034
        os.link(src, dest)
1144
 
    except (OSError, IOError) as e:
 
1035
    except (OSError, IOError), e:
1145
1036
        if e.errno != errno.EXDEV:
1146
1037
            raise
1147
1038
        shutil.copyfile(src, dest)
1148
1039
 
1149
1040
 
1150
1041
def delete_any(path):
1151
 
    """Delete a file, symlink or directory.
1152
 
 
 
1042
    """Delete a file, symlink or directory.  
 
1043
    
1153
1044
    Will delete even if readonly.
1154
1045
    """
1155
1046
    try:
1156
1047
       _delete_file_or_dir(path)
1157
 
    except (OSError, IOError) as e:
 
1048
    except (OSError, IOError), e:
1158
1049
        if e.errno in (errno.EPERM, errno.EACCES):
1159
1050
            # make writable and try again
1160
1051
            try:
1220
1111
    #    separators
1221
1112
    # 3) '\xa0' isn't unicode safe since it is >128.
1222
1113
 
1223
 
    if isinstance(s, str):
1224
 
        ws = ' \t\n\r\v\f'
1225
 
    else:
1226
 
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
1227
 
    for ch in ws:
 
1114
    # This should *not* be a unicode set of characters in case the source
 
1115
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1116
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1117
    # is utf-8
 
1118
    for ch in ' \t\n\r\v\f':
1228
1119
        if ch in s:
1229
1120
            return True
1230
1121
    else:
1241
1132
 
1242
1133
 
1243
1134
def relpath(base, path):
1244
 
    """Return path relative to base, or raise PathNotChild exception.
 
1135
    """Return path relative to base, or raise exception.
1245
1136
 
1246
1137
    The path may be either an absolute path or a path relative to the
1247
1138
    current working directory.
1249
1140
    os.path.commonprefix (python2.4) has a bad bug that it works just
1250
1141
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1251
1142
    avoids that problem.
1252
 
 
1253
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1254
 
    PathNotChild exceptions regardless of `path`.
1255
1143
    """
1256
1144
 
1257
1145
    if len(base) < MIN_ABS_PATHLENGTH:
1258
1146
        # must have space for e.g. a drive letter
1259
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1147
        raise ValueError('%r is too short to calculate a relative path'
1260
1148
            % (base,))
1261
1149
 
1262
1150
    rp = abspath(path)
1344
1232
    # but for now, we haven't optimized...
1345
1233
    return [canonical_relpath(base, p) for p in paths]
1346
1234
 
1347
 
 
1348
 
def decode_filename(filename):
1349
 
    """Decode the filename using the filesystem encoding
1350
 
 
1351
 
    If it is unicode, it is returned.
1352
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1353
 
    fails, a errors.BadFilenameEncoding exception is raised.
1354
 
    """
1355
 
    if isinstance(filename, text_type):
1356
 
        return filename
1357
 
    try:
1358
 
        return filename.decode(_fs_enc)
1359
 
    except UnicodeDecodeError:
1360
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1361
 
 
1362
 
 
1363
1235
def safe_unicode(unicode_or_utf8_string):
1364
1236
    """Coerce unicode_or_utf8_string into unicode.
1365
1237
 
1367
1239
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1368
1240
    wrapped in a BzrBadParameterNotUnicode exception.
1369
1241
    """
1370
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1242
    if isinstance(unicode_or_utf8_string, unicode):
1371
1243
        return unicode_or_utf8_string
1372
1244
    try:
1373
1245
        return unicode_or_utf8_string.decode('utf8')
1381
1253
    If it is a str, it is returned.
1382
1254
    If it is Unicode, it is encoded into a utf-8 string.
1383
1255
    """
1384
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1256
    if isinstance(unicode_or_utf8_string, str):
1385
1257
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1386
1258
        #       performance if we are dealing with lots of apis that want a
1387
1259
        #       utf-8 revision id
1394
1266
    return unicode_or_utf8_string.encode('utf-8')
1395
1267
 
1396
1268
 
1397
 
def safe_revision_id(unicode_or_utf8_string):
 
1269
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1270
                        ' Revision id generators should be creating utf8'
 
1271
                        ' revision ids.')
 
1272
 
 
1273
 
 
1274
def safe_revision_id(unicode_or_utf8_string, warn=True):
1398
1275
    """Revision ids should now be utf8, but at one point they were unicode.
1399
1276
 
1400
1277
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1401
1278
        utf8 or None).
 
1279
    :param warn: Functions that are sanitizing user data can set warn=False
1402
1280
    :return: None or a utf8 revision id.
1403
1281
    """
1404
1282
    if (unicode_or_utf8_string is None
1405
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1283
        or unicode_or_utf8_string.__class__ == str):
1406
1284
        return unicode_or_utf8_string
1407
 
    raise TypeError('Unicode revision ids are no longer supported. '
1408
 
                    'Revision id generators should be creating utf8 revision '
1409
 
                    'ids.')
1410
 
 
1411
 
 
1412
 
def safe_file_id(unicode_or_utf8_string):
 
1285
    if warn:
 
1286
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1287
                               stacklevel=2)
 
1288
    return cache_utf8.encode(unicode_or_utf8_string)
 
1289
 
 
1290
 
 
1291
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1292
                    ' generators should be creating utf8 file ids.')
 
1293
 
 
1294
 
 
1295
def safe_file_id(unicode_or_utf8_string, warn=True):
1413
1296
    """File ids should now be utf8, but at one point they were unicode.
1414
1297
 
1415
1298
    This is the same as safe_utf8, except it uses the cached encode functions
1417
1300
 
1418
1301
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1419
1302
        utf8 or None).
 
1303
    :param warn: Functions that are sanitizing user data can set warn=False
1420
1304
    :return: None or a utf8 file id.
1421
1305
    """
1422
1306
    if (unicode_or_utf8_string is None
1423
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1307
        or unicode_or_utf8_string.__class__ == str):
1424
1308
        return unicode_or_utf8_string
1425
 
    raise TypeError('Unicode file ids are no longer supported. '
1426
 
                    'File id generators should be creating utf8 file ids.')
 
1309
    if warn:
 
1310
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1311
                               stacklevel=2)
 
1312
    return cache_utf8.encode(unicode_or_utf8_string)
1427
1313
 
1428
1314
 
1429
1315
_platform_normalizes_filenames = False
1434
1320
def normalizes_filenames():
1435
1321
    """Return True if this platform normalizes unicode filenames.
1436
1322
 
1437
 
    Only Mac OSX.
 
1323
    Mac OSX does, Windows/Linux do not.
1438
1324
    """
1439
1325
    return _platform_normalizes_filenames
1440
1326
 
1445
1331
    On platforms where the system normalizes filenames (Mac OSX),
1446
1332
    you can access a file by any path which will normalize correctly.
1447
1333
    On platforms where the system does not normalize filenames
1448
 
    (everything else), you have to access a file by its exact path.
 
1334
    (Windows, Linux), you have to access a file by its exact path.
1449
1335
 
1450
1336
    Internally, bzr only supports NFC normalization, since that is
1451
1337
    the standard for XML documents.
1454
1340
    can be accessed by that path.
1455
1341
    """
1456
1342
 
1457
 
    if isinstance(path, bytes):
1458
 
        path = path.decode(sys.getfilesystemencoding())
1459
 
    return unicodedata.normalize('NFC', path), True
 
1343
    return unicodedata.normalize('NFC', unicode(path)), True
1460
1344
 
1461
1345
 
1462
1346
def _inaccessible_normalized_filename(path):
1463
1347
    __doc__ = _accessible_normalized_filename.__doc__
1464
1348
 
1465
 
    if isinstance(path, bytes):
1466
 
        path = path.decode(sys.getfilesystemencoding())
1467
 
    normalized = unicodedata.normalize('NFC', path)
 
1349
    normalized = unicodedata.normalize('NFC', unicode(path))
1468
1350
    return normalized, normalized == path
1469
1351
 
1470
1352
 
1483
1365
        False)`).  May be ignored if the feature is not available on this
1484
1366
        platform or Python version.
1485
1367
    """
1486
 
    try:
1487
 
        import signal
1488
 
        siginterrupt = signal.siginterrupt
1489
 
    except ImportError:
1490
 
        # This python implementation doesn't provide signal support, hence no
1491
 
        # handler exists
1492
 
        return None
1493
 
    except AttributeError:
1494
 
        # siginterrupt doesn't exist on this platform, or for this version
1495
 
        # of Python.
1496
 
        siginterrupt = lambda signum, flag: None
 
1368
    old_handler = signal.signal(signum, handler)
1497
1369
    if restart_syscall:
1498
 
        def sig_handler(*args):
1499
 
            # Python resets the siginterrupt flag when a signal is
1500
 
            # received.  <http://bugs.python.org/issue8354>
1501
 
            # As a workaround for some cases, set it back the way we want it.
 
1370
        try:
 
1371
            siginterrupt = signal.siginterrupt
 
1372
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1373
            # Python.
 
1374
            pass
 
1375
        else:
1502
1376
            siginterrupt(signum, False)
1503
 
            # Now run the handler function passed to set_signal_handler.
1504
 
            handler(*args)
1505
 
    else:
1506
 
        sig_handler = handler
1507
 
    old_handler = signal.signal(signum, sig_handler)
1508
 
    if restart_syscall:
1509
 
        siginterrupt(signum, False)
1510
1377
    return old_handler
1511
1378
 
1512
1379
 
1517
1384
terminal_width() returns None.
1518
1385
"""
1519
1386
 
1520
 
# Keep some state so that terminal_width can detect if _terminal_size has
1521
 
# returned a different size since the process started.  See docstring and
1522
 
# comments of terminal_width for details.
1523
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1524
 
_terminal_size_state = 'no_data'
1525
 
_first_terminal_size = None
1526
1387
 
1527
1388
def terminal_width():
1528
1389
    """Return terminal width.
1530
1391
    None is returned if the width can't established precisely.
1531
1392
 
1532
1393
    The rules are:
1533
 
    - if BRZ_COLUMNS is set, returns its value
 
1394
    - if BZR_COLUMNS is set, returns its value
1534
1395
    - if there is no controlling terminal, returns None
1535
 
    - query the OS, if the queried size has changed since the last query,
1536
 
      return its value,
1537
1396
    - if COLUMNS is set, returns its value,
1538
 
    - if the OS has a value (even though it's never changed), return its value.
1539
1397
 
1540
1398
    From there, we need to query the OS to get the size of the controlling
1541
1399
    terminal.
1542
1400
 
1543
 
    On Unices we query the OS by:
 
1401
    Unices:
1544
1402
    - get termios.TIOCGWINSZ
1545
1403
    - if an error occurs or a negative value is obtained, returns None
1546
1404
 
1547
 
    On Windows we query the OS by:
 
1405
    Windows:
 
1406
    
1548
1407
    - win32utils.get_console_size() decides,
1549
1408
    - returns None on error (provided default value)
1550
1409
    """
1551
 
    # Note to implementors: if changing the rules for determining the width,
1552
 
    # make sure you've considered the behaviour in these cases:
1553
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1554
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1555
 
    #    0,0.
1556
 
    #  - (add more interesting cases here, if you find any)
1557
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1558
 
    # but we don't want to register a signal handler because it is impossible
1559
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1560
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1561
 
    # time so we can notice if the reported size has changed, which should have
1562
 
    # a similar effect.
1563
1410
 
1564
 
    # If BRZ_COLUMNS is set, take it, user is always right
1565
 
    # Except if they specified 0 in which case, impose no limit here
 
1411
    # If BZR_COLUMNS is set, take it, user is always right
1566
1412
    try:
1567
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1413
        return int(os.environ['BZR_COLUMNS'])
1568
1414
    except (KeyError, ValueError):
1569
 
        width = None
1570
 
    if width is not None:
1571
 
        if width > 0:
1572
 
            return width
1573
 
        else:
1574
 
            return None
 
1415
        pass
1575
1416
 
1576
1417
    isatty = getattr(sys.stdout, 'isatty', None)
1577
 
    if isatty is None or not isatty():
1578
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1418
    if  isatty is None or not isatty():
 
1419
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1579
1420
        return None
1580
1421
 
1581
 
    # Query the OS
1582
 
    width, height = os_size = _terminal_size(None, None)
1583
 
    global _first_terminal_size, _terminal_size_state
1584
 
    if _terminal_size_state == 'no_data':
1585
 
        _first_terminal_size = os_size
1586
 
        _terminal_size_state = 'unchanged'
1587
 
    elif (_terminal_size_state == 'unchanged' and
1588
 
          _first_terminal_size != os_size):
1589
 
        _terminal_size_state = 'changed'
1590
 
 
1591
 
    # If the OS claims to know how wide the terminal is, and this value has
1592
 
    # ever changed, use that.
1593
 
    if _terminal_size_state == 'changed':
1594
 
        if width is not None and width > 0:
1595
 
            return width
1596
 
 
1597
 
    # If COLUMNS is set, use it.
 
1422
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1423
    # given terminal, the application can decide to set COLUMNS to a lower
 
1424
    # value (splitted screen) or a bigger value (scroll bars))
1598
1425
    try:
1599
1426
        return int(os.environ['COLUMNS'])
1600
1427
    except (KeyError, ValueError):
1601
1428
        pass
1602
1429
 
1603
 
    # Finally, use an unchanged size from the OS, if we have one.
1604
 
    if _terminal_size_state == 'unchanged':
1605
 
        if width is not None and width > 0:
1606
 
            return width
 
1430
    width, height = _terminal_size(None, None)
 
1431
    if width <= 0:
 
1432
        # Consider invalid values as meaning no width
 
1433
        return None
1607
1434
 
1608
 
    # The width could not be determined.
1609
 
    return None
 
1435
    return width
1610
1436
 
1611
1437
 
1612
1438
def _win32_terminal_size(width, height):
1639
1465
    _terminal_size = _ioctl_terminal_size
1640
1466
 
1641
1467
 
 
1468
def _terminal_size_changed(signum, frame):
 
1469
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1470
    width, height = _terminal_size(None, None)
 
1471
    if width is not None:
 
1472
        os.environ['COLUMNS'] = str(width)
 
1473
 
 
1474
 
 
1475
_registered_sigwinch = False
 
1476
 
 
1477
def watch_sigwinch():
 
1478
    """Register for SIGWINCH, once and only once."""
 
1479
    global _registered_sigwinch
 
1480
    if not _registered_sigwinch:
 
1481
        if sys.platform == 'win32':
 
1482
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1483
            # ReadConsoleInput but I've no idea how to plug that in
 
1484
            # the current design -- vila 20091216
 
1485
            pass
 
1486
        else:
 
1487
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1488
        _registered_sigwinch = True
 
1489
 
 
1490
 
1642
1491
def supports_executable():
1643
1492
    return sys.platform != "win32"
1644
1493
 
1669
1518
        if orig_val is not None:
1670
1519
            del os.environ[env_variable]
1671
1520
    else:
1672
 
        if not PY3 and isinstance(value, text_type):
 
1521
        if isinstance(value, unicode):
1673
1522
            value = value.encode(get_user_encoding())
1674
1523
        os.environ[env_variable] = value
1675
1524
    return orig_val
1767
1616
        dirblock = []
1768
1617
        append = dirblock.append
1769
1618
        try:
1770
 
            names = sorted(map(decode_filename, _listdir(top)))
1771
 
        except OSError as e:
 
1619
            names = sorted(_listdir(top))
 
1620
        except OSError, e:
1772
1621
            if not _is_error_enotdir(e):
1773
1622
                raise
1774
1623
        else:
1827
1676
    """
1828
1677
    global _selected_dir_reader
1829
1678
    if _selected_dir_reader is None:
1830
 
        if sys.platform == "win32":
 
1679
        fs_encoding = _fs_enc.upper()
 
1680
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1681
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1682
            # TODO: We possibly could support Win98 by falling back to the
 
1683
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1684
            #       but that gets a bit tricky, and requires custom compiling
 
1685
            #       for win98 anyway.
1831
1686
            try:
1832
 
                from ._walkdirs_win32 import Win32ReadDir
 
1687
                from bzrlib._walkdirs_win32 import Win32ReadDir
1833
1688
                _selected_dir_reader = Win32ReadDir()
1834
1689
            except ImportError:
1835
1690
                pass
1836
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1691
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1692
            # ANSI_X3.4-1968 is a form of ASCII
1837
1693
            try:
1838
 
                from ._readdir_pyx import UTF8DirReader
 
1694
                from bzrlib._readdir_pyx import UTF8DirReader
1839
1695
                _selected_dir_reader = UTF8DirReader()
1840
 
            except ImportError as e:
 
1696
            except ImportError, e:
1841
1697
                failed_to_load_extension(e)
1842
1698
                pass
1843
1699
 
1893
1749
        _kind_from_mode = file_kind_from_stat_mode
1894
1750
 
1895
1751
        if prefix:
1896
 
            relprefix = prefix + b'/'
 
1752
            relprefix = prefix + '/'
1897
1753
        else:
1898
 
            relprefix = b''
1899
 
        top_slash = top + '/'
 
1754
            relprefix = ''
 
1755
        top_slash = top + u'/'
1900
1756
 
1901
1757
        dirblock = []
1902
1758
        append = dirblock.append
1941
1797
        link_to = os.readlink(source)
1942
1798
        os.symlink(link_to, dest)
1943
1799
 
1944
 
    real_handlers = {'file': shutil.copy2,
1945
 
                     'symlink': copy_link,
1946
 
                     'directory': copy_dir,
 
1800
    real_handlers = {'file':shutil.copy2,
 
1801
                     'symlink':copy_link,
 
1802
                     'directory':copy_dir,
1947
1803
                    }
1948
1804
    real_handlers.update(handlers)
1949
1805
 
1955
1811
            real_handlers[kind](abspath, relpath)
1956
1812
 
1957
1813
 
1958
 
def copy_ownership_from_path(dst, src=None):
 
1814
def copy_ownership(dst, src=None):
1959
1815
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1960
1816
 
1961
1817
    If src is None, the containing directory is used as source. If chown
1973
1829
    try:
1974
1830
        s = os.stat(src)
1975
1831
        chown(dst, s.st_uid, s.st_gid)
1976
 
    except OSError as e:
1977
 
        trace.warning(
1978
 
            'Unable to copy ownership from "%s" to "%s". '
1979
 
            'You may want to set it manually.', src, dst)
1980
 
        trace.log_exception_quietly()
 
1832
    except OSError, e:
 
1833
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1834
 
 
1835
 
 
1836
def mkdir_with_ownership(path, ownership_src=None):
 
1837
    """Create the directory 'path' with specified ownership.
 
1838
 
 
1839
    If ownership_src is given, copies (chown) usr/grp ownership
 
1840
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1841
    containing dir ownership.
 
1842
    """
 
1843
    os.mkdir(path)
 
1844
    copy_ownership(path, ownership_src)
 
1845
 
 
1846
 
 
1847
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1848
    """Open the file 'filename' with the specified ownership.
 
1849
 
 
1850
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1851
    to filename. If ownership_src is None, copy ownership from containing
 
1852
    directory.
 
1853
    Returns the opened file object.
 
1854
    """
 
1855
    f = open(filename, mode, bufsize)
 
1856
    copy_ownership(filename, ownership_src)
 
1857
    return f
1981
1858
 
1982
1859
 
1983
1860
def path_prefix_key(path):
1985
1862
 
1986
1863
    This can be used to sort paths in the same way that walkdirs does.
1987
1864
    """
1988
 
    return (dirname(path), path)
 
1865
    return (dirname(path) , path)
1989
1866
 
1990
1867
 
1991
1868
def compare_paths_prefix_order(path_a, path_b):
1998
1875
_cached_user_encoding = None
1999
1876
 
2000
1877
 
2001
 
def get_user_encoding():
 
1878
def get_user_encoding(use_cache=True):
2002
1879
    """Find out what the preferred user encoding is.
2003
1880
 
2004
1881
    This is generally the encoding that is used for command line parameters
2005
1882
    and file contents. This may be different from the terminal encoding
2006
1883
    or the filesystem encoding.
2007
1884
 
 
1885
    :param  use_cache:  Enable cache for detected encoding.
 
1886
                        (This parameter is turned on by default,
 
1887
                        and required only for selftesting)
 
1888
 
2008
1889
    :return: A string defining the preferred user encoding
2009
1890
    """
2010
1891
    global _cached_user_encoding
2011
 
    if _cached_user_encoding is not None:
 
1892
    if _cached_user_encoding is not None and use_cache:
2012
1893
        return _cached_user_encoding
2013
1894
 
2014
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2015
 
        # Use the existing locale settings and call nl_langinfo directly
2016
 
        # rather than going through getpreferredencoding. This avoids
2017
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2018
 
        # possibility of the setlocale call throwing an error.
2019
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1895
    if sys.platform == 'darwin':
 
1896
        # python locale.getpreferredencoding() always return
 
1897
        # 'mac-roman' on darwin. That's a lie.
 
1898
        sys.platform = 'posix'
 
1899
        try:
 
1900
            if os.environ.get('LANG', None) is None:
 
1901
                # If LANG is not set, we end up with 'ascii', which is bad
 
1902
                # ('mac-roman' is more than ascii), so we set a default which
 
1903
                # will give us UTF-8 (which appears to work in all cases on
 
1904
                # OSX). Users are still free to override LANG of course, as
 
1905
                # long as it give us something meaningful. This work-around
 
1906
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1907
                # work with them too -- vila 20080908
 
1908
                os.environ['LANG'] = 'en_US.UTF-8'
 
1909
            import locale
 
1910
        finally:
 
1911
            sys.platform = 'darwin'
2020
1912
    else:
2021
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2022
 
        user_encoding = locale.getpreferredencoding(False)
 
1913
        import locale
2023
1914
 
2024
1915
    try:
2025
 
        user_encoding = codecs.lookup(user_encoding).name
2026
 
    except LookupError:
2027
 
        if user_encoding not in ("", "cp0"):
2028
 
            sys.stderr.write('brz: warning:'
 
1916
        user_encoding = locale.getpreferredencoding()
 
1917
    except locale.Error, e:
 
1918
        sys.stderr.write('bzr: warning: %s\n'
 
1919
                         '  Could not determine what text encoding to use.\n'
 
1920
                         '  This error usually means your Python interpreter\n'
 
1921
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1922
                         "  Continuing with ascii encoding.\n"
 
1923
                         % (e, os.environ.get('LANG')))
 
1924
        user_encoding = 'ascii'
 
1925
 
 
1926
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1927
    # treat that as ASCII, and not support printing unicode characters to the
 
1928
    # console.
 
1929
    #
 
1930
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1931
    if user_encoding in (None, 'cp0', ''):
 
1932
        user_encoding = 'ascii'
 
1933
    else:
 
1934
        # check encoding
 
1935
        try:
 
1936
            codecs.lookup(user_encoding)
 
1937
        except LookupError:
 
1938
            sys.stderr.write('bzr: warning:'
2029
1939
                             ' unknown encoding %s.'
2030
1940
                             ' Continuing with ascii encoding.\n'
2031
1941
                             % user_encoding
2032
1942
                            )
2033
 
        user_encoding = 'ascii'
2034
 
    else:
2035
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2036
 
        if user_encoding == 'ascii':
2037
 
            if sys.platform == 'darwin':
2038
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2039
 
                # encoding and previously had LANG set here if not present.
2040
 
                user_encoding = 'utf-8'
2041
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2042
 
            #                for some other posix platforms as well.
2043
 
 
2044
 
    _cached_user_encoding = user_encoding
 
1943
            user_encoding = 'ascii'
 
1944
 
 
1945
    if use_cache:
 
1946
        _cached_user_encoding = user_encoding
 
1947
 
2045
1948
    return user_encoding
2046
1949
 
2047
1950
 
2048
 
def get_diff_header_encoding():
2049
 
    return get_terminal_encoding()
2050
 
 
2051
 
 
2052
1951
def get_host_name():
2053
1952
    """Return the current unicode host name.
2054
1953
 
2056
1955
    behaves inconsistently on different platforms.
2057
1956
    """
2058
1957
    if sys.platform == "win32":
 
1958
        import win32utils
2059
1959
        return win32utils.get_host_name()
2060
1960
    else:
2061
1961
        import socket
2062
 
        if PY3:
2063
 
            return socket.gethostname()
2064
1962
        return socket.gethostname().decode(get_user_encoding())
2065
1963
 
2066
1964
 
2070
1968
# data at once.
2071
1969
MAX_SOCKET_CHUNK = 64 * 1024
2072
1970
 
2073
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2074
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2075
 
    _eno = getattr(errno, _eno, None)
2076
 
    if _eno is not None:
2077
 
        _end_of_stream_errors.append(_eno)
2078
 
del _eno
2079
 
 
2080
 
 
2081
1971
def read_bytes_from_socket(sock, report_activity=None,
2082
1972
        max_read_size=MAX_SOCKET_CHUNK):
2083
1973
    """Read up to max_read_size of bytes from sock and notify of progress.
2086
1976
    empty string rather than raise an error), and repeats the recv if
2087
1977
    interrupted by a signal.
2088
1978
    """
2089
 
    while True:
 
1979
    while 1:
2090
1980
        try:
2091
 
            data = sock.recv(max_read_size)
2092
 
        except socket.error as e:
 
1981
            bytes = sock.recv(max_read_size)
 
1982
        except socket.error, e:
2093
1983
            eno = e.args[0]
2094
 
            if eno in _end_of_stream_errors:
 
1984
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2095
1985
                # The connection was closed by the other side.  Callers expect
2096
1986
                # an empty string to signal end-of-stream.
2097
 
                return b""
 
1987
                return ""
2098
1988
            elif eno == errno.EINTR:
2099
1989
                # Retry the interrupted recv.
2100
1990
                continue
2101
1991
            raise
2102
1992
        else:
2103
1993
            if report_activity is not None:
2104
 
                report_activity(len(data), 'read')
2105
 
            return data
 
1994
                report_activity(len(bytes), 'read')
 
1995
            return bytes
2106
1996
 
2107
1997
 
2108
1998
def recv_all(socket, count):
2115
2005
 
2116
2006
    This isn't optimized and is intended mostly for use in testing.
2117
2007
    """
2118
 
    b = b''
 
2008
    b = ''
2119
2009
    while len(b) < count:
2120
2010
        new = read_bytes_from_socket(socket, None, count - len(b))
2121
 
        if new == b'':
 
2011
        if new == '':
2122
2012
            break # eof
2123
2013
        b += new
2124
2014
    return b
2126
2016
 
2127
2017
def send_all(sock, bytes, report_activity=None):
2128
2018
    """Send all bytes on a socket.
2129
 
 
 
2019
 
2130
2020
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2131
2021
    some platforms, and catches EINTR which may be thrown if the send is
2132
2022
    interrupted by a signal.
2133
2023
 
2134
2024
    This is preferred to socket.sendall(), because it avoids portability bugs
2135
2025
    and provides activity reporting.
2136
 
 
 
2026
 
2137
2027
    :param report_activity: Call this as bytes are read, see
2138
2028
        Transport._report_activity
2139
2029
    """
2140
2030
    sent_total = 0
2141
2031
    byte_count = len(bytes)
2142
 
    view = memoryview(bytes)
2143
2032
    while sent_total < byte_count:
2144
2033
        try:
2145
 
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2146
 
        except (socket.error, IOError) as e:
2147
 
            if e.args[0] in _end_of_stream_errors:
2148
 
                raise errors.ConnectionReset(
2149
 
                    "Error trying to write to socket", e)
 
2034
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2035
        except socket.error, e:
2150
2036
            if e.args[0] != errno.EINTR:
2151
2037
                raise
2152
2038
        else:
2153
 
            if sent == 0:
2154
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2155
 
                                             % (sock,))
2156
2039
            sent_total += sent
2157
 
            if report_activity is not None:
2158
 
                report_activity(sent, 'write')
2159
 
 
2160
 
 
2161
 
def connect_socket(address):
2162
 
    # Slight variation of the socket.create_connection() function (provided by
2163
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2164
 
    # provide it for previous python versions. Also, we don't use the timeout
2165
 
    # parameter (provided by the python implementation) so we don't implement
2166
 
    # it either).
2167
 
    err = socket.error('getaddrinfo returns an empty list')
2168
 
    host, port = address
2169
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2170
 
        af, socktype, proto, canonname, sa = res
2171
 
        sock = None
2172
 
        try:
2173
 
            sock = socket.socket(af, socktype, proto)
2174
 
            sock.connect(sa)
2175
 
            return sock
2176
 
 
2177
 
        except socket.error as e:
2178
 
            err = e
2179
 
            # 'err' is now the most recent error
2180
 
            if sock is not None:
2181
 
                sock.close()
2182
 
    raise err
 
2040
            report_activity(sent, 'write')
2183
2041
 
2184
2042
 
2185
2043
def dereference_path(path):
2204
2062
def resource_string(package, resource_name):
2205
2063
    """Load a resource from a package and return it as a string.
2206
2064
 
2207
 
    Note: Only packages that start with breezy are currently supported.
 
2065
    Note: Only packages that start with bzrlib are currently supported.
2208
2066
 
2209
2067
    This is designed to be a lightweight implementation of resource
2210
2068
    loading in a way which is API compatible with the same API from
2213
2071
    If and when pkg_resources becomes a standard library, this routine
2214
2072
    can delegate to it.
2215
2073
    """
2216
 
    # Check package name is within breezy
2217
 
    if package == "breezy":
 
2074
    # Check package name is within bzrlib
 
2075
    if package == "bzrlib":
2218
2076
        resource_relpath = resource_name
2219
 
    elif package.startswith("breezy."):
2220
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2077
    elif package.startswith("bzrlib."):
 
2078
        package = package[len("bzrlib."):].replace('.', os.sep)
2221
2079
        resource_relpath = pathjoin(package, resource_name)
2222
2080
    else:
2223
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2081
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2224
2082
 
2225
2083
    # Map the resource to a file and read its contents
2226
 
    base = dirname(breezy.__file__)
 
2084
    base = dirname(bzrlib.__file__)
2227
2085
    if getattr(sys, 'frozen', None):    # bzr.exe
2228
2086
        base = abspath(pathjoin(base, '..', '..'))
2229
 
    with open(pathjoin(base, resource_relpath), "rU") as f:
2230
 
        return f.read()
 
2087
    filename = pathjoin(base, resource_relpath)
 
2088
    return open(filename, 'rU').read()
 
2089
 
2231
2090
 
2232
2091
def file_kind_from_stat_mode_thunk(mode):
2233
2092
    global file_kind_from_stat_mode
2234
2093
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2235
2094
        try:
2236
 
            from ._readdir_pyx import UTF8DirReader
 
2095
            from bzrlib._readdir_pyx import UTF8DirReader
2237
2096
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2238
 
        except ImportError as e:
 
2097
        except ImportError, e:
2239
2098
            # This is one time where we won't warn that an extension failed to
2240
2099
            # load. The extension is never available on Windows anyway.
2241
 
            from ._readdir_py import (
 
2100
            from bzrlib._readdir_py import (
2242
2101
                _kind_from_mode as file_kind_from_stat_mode
2243
2102
                )
2244
2103
    return file_kind_from_stat_mode(mode)
2245
2104
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2246
2105
 
2247
 
def file_stat(f, _lstat=os.lstat):
 
2106
 
 
2107
def file_kind(f, _lstat=os.lstat):
2248
2108
    try:
2249
 
        # XXX cache?
2250
 
        return _lstat(f)
2251
 
    except OSError as e:
 
2109
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2110
    except OSError, e:
2252
2111
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2253
2112
            raise errors.NoSuchFile(f)
2254
2113
        raise
2255
2114
 
2256
 
def file_kind(f, _lstat=os.lstat):
2257
 
    stat_value = file_stat(f, _lstat)
2258
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2259
2115
 
2260
2116
def until_no_eintr(f, *a, **kw):
2261
2117
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2262
 
 
 
2118
    
2263
2119
    WARNING: you must be certain that it is safe to retry the call repeatedly
2264
2120
    if EINTR does occur.  This is typically only true for low-level operations
2265
2121
    like os.read.  If in any doubt, don't use this.
2267
2123
    Keep in mind that this is not a complete solution to EINTR.  There is
2268
2124
    probably code in the Python standard library and other dependencies that
2269
2125
    may encounter EINTR if a signal arrives (and there is signal handler for
2270
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2126
    that signal).  So this function can reduce the impact for IO that bzrlib
2271
2127
    directly controls, but it is not a complete solution.
2272
2128
    """
2273
2129
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2274
2130
    while True:
2275
2131
        try:
2276
2132
            return f(*a, **kw)
2277
 
        except (IOError, OSError) as e:
 
2133
        except (IOError, OSError), e:
2278
2134
            if e.errno == errno.EINTR:
2279
2135
                continue
2280
2136
            raise
2281
2137
 
2282
2138
 
 
2139
def re_compile_checked(re_string, flags=0, where=""):
 
2140
    """Return a compiled re, or raise a sensible error.
 
2141
 
 
2142
    This should only be used when compiling user-supplied REs.
 
2143
 
 
2144
    :param re_string: Text form of regular expression.
 
2145
    :param flags: eg re.IGNORECASE
 
2146
    :param where: Message explaining to the user the context where
 
2147
        it occurred, eg 'log search filter'.
 
2148
    """
 
2149
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2150
    try:
 
2151
        re_obj = re.compile(re_string, flags)
 
2152
        re_obj.search("")
 
2153
        return re_obj
 
2154
    except re.error, e:
 
2155
        if where:
 
2156
            where = ' in ' + where
 
2157
        # despite the name 'error' is a type
 
2158
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2159
            % (where, re_string, e))
 
2160
 
 
2161
 
2283
2162
if sys.platform == "win32":
 
2163
    import msvcrt
2284
2164
    def getchar():
2285
 
        import msvcrt
2286
2165
        return msvcrt.getch()
2287
2166
else:
 
2167
    import tty
 
2168
    import termios
2288
2169
    def getchar():
2289
 
        import tty
2290
 
        import termios
2291
2170
        fd = sys.stdin.fileno()
2292
2171
        settings = termios.tcgetattr(fd)
2293
2172
        try:
2297
2176
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2298
2177
        return ch
2299
2178
 
2300
 
if sys.platform.startswith('linux'):
 
2179
 
 
2180
if sys.platform == 'linux2':
2301
2181
    def _local_concurrency():
2302
 
        try:
2303
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2304
 
        except (ValueError, OSError, AttributeError):
2305
 
            return None
 
2182
        concurrency = None
 
2183
        prefix = 'processor'
 
2184
        for line in file('/proc/cpuinfo', 'rb'):
 
2185
            if line.startswith(prefix):
 
2186
                concurrency = int(line[line.find(':')+1:]) + 1
 
2187
        return concurrency
2306
2188
elif sys.platform == 'darwin':
2307
2189
    def _local_concurrency():
2308
2190
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2309
2191
                                stdout=subprocess.PIPE).communicate()[0]
2310
 
elif "bsd" in sys.platform:
 
2192
elif sys.platform[0:7] == 'freebsd':
2311
2193
    def _local_concurrency():
2312
2194
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2313
2195
                                stdout=subprocess.PIPE).communicate()[0]
2338
2220
    if _cached_local_concurrency is not None and use_cache:
2339
2221
        return _cached_local_concurrency
2340
2222
 
2341
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2223
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2342
2224
    if concurrency is None:
2343
 
        import multiprocessing
2344
2225
        try:
2345
 
            concurrency = multiprocessing.cpu_count()
2346
 
        except NotImplementedError:
2347
 
            # multiprocessing.cpu_count() isn't implemented on all platforms
2348
 
            try:
2349
 
                concurrency = _local_concurrency()
2350
 
            except (OSError, IOError):
2351
 
                pass
 
2226
            concurrency = _local_concurrency()
 
2227
        except (OSError, IOError):
 
2228
            pass
2352
2229
    try:
2353
2230
        concurrency = int(concurrency)
2354
2231
    except (TypeError, ValueError):
2366
2243
        self.encode = encode
2367
2244
 
2368
2245
    def write(self, object):
2369
 
        if isinstance(object, str):
 
2246
        if type(object) is str:
2370
2247
            self.stream.write(object)
2371
2248
        else:
2372
2249
            data, _ = self.encode(object, self.errors)
2375
2252
if sys.platform == 'win32':
2376
2253
    def open_file(filename, mode='r', bufsize=-1):
2377
2254
        """This function is used to override the ``open`` builtin.
2378
 
 
 
2255
        
2379
2256
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2380
2257
        child processes.  Deleting or renaming a closed file opened with this
2381
2258
        function is not blocking child processes.
2414
2291
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2415
2292
else:
2416
2293
    open_file = open
2417
 
 
2418
 
 
2419
 
def available_backup_name(base, exists):
2420
 
    """Find a non-existing backup file name.
2421
 
 
2422
 
    This will *not* create anything, this only return a 'free' entry.  This
2423
 
    should be used for checking names in a directory below a locked
2424
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2425
 
    Leap) and generally discouraged.
2426
 
 
2427
 
    :param base: The base name.
2428
 
 
2429
 
    :param exists: A callable returning True if the path parameter exists.
2430
 
    """
2431
 
    counter = 1
2432
 
    name = "%s.~%d~" % (base, counter)
2433
 
    while exists(name):
2434
 
        counter += 1
2435
 
        name = "%s.~%d~" % (base, counter)
2436
 
    return name
2437
 
 
2438
 
 
2439
 
def set_fd_cloexec(fd):
2440
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2441
 
    support for this is not available.
2442
 
    """
2443
 
    try:
2444
 
        import fcntl
2445
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2446
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2447
 
    except (ImportError, AttributeError):
2448
 
        # Either the fcntl module or specific constants are not present
2449
 
        pass
2450
 
 
2451
 
 
2452
 
def find_executable_on_path(name):
2453
 
    """Finds an executable on the PATH.
2454
 
    
2455
 
    On Windows, this will try to append each extension in the PATHEXT
2456
 
    environment variable to the name, if it cannot be found with the name
2457
 
    as given.
2458
 
    
2459
 
    :param name: The base name of the executable.
2460
 
    :return: The path to the executable found or None.
2461
 
    """
2462
 
    if sys.platform == 'win32':
2463
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2464
 
        exts = [ext.lower() for ext in exts]
2465
 
        base, ext = os.path.splitext(name)
2466
 
        if ext != '':
2467
 
            if ext.lower() not in exts:
2468
 
                return None
2469
 
            name = base
2470
 
            exts = [ext]
2471
 
    else:
2472
 
        exts = ['']
2473
 
    path = os.environ.get('PATH')
2474
 
    if path is not None:
2475
 
        path = path.split(os.pathsep)
2476
 
        for ext in exts:
2477
 
            for d in path:
2478
 
                f = os.path.join(d, name) + ext
2479
 
                if os.access(f, os.X_OK):
2480
 
                    return f
2481
 
    if sys.platform == 'win32':
2482
 
        app_path = win32utils.get_app_path(name)
2483
 
        if app_path != name:
2484
 
            return app_path
2485
 
    return None
2486
 
 
2487
 
 
2488
 
def _posix_is_local_pid_dead(pid):
2489
 
    """True if pid doesn't correspond to live process on this machine"""
2490
 
    try:
2491
 
        # Special meaning of unix kill: just check if it's there.
2492
 
        os.kill(pid, 0)
2493
 
    except OSError as e:
2494
 
        if e.errno == errno.ESRCH:
2495
 
            # On this machine, and really not found: as sure as we can be
2496
 
            # that it's dead.
2497
 
            return True
2498
 
        elif e.errno == errno.EPERM:
2499
 
            # exists, though not ours
2500
 
            return False
2501
 
        else:
2502
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2503
 
            # Don't really know.
2504
 
            return False
2505
 
    else:
2506
 
        # Exists and our process: not dead.
2507
 
        return False
2508
 
 
2509
 
if sys.platform == "win32":
2510
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2511
 
else:
2512
 
    is_local_pid_dead = _posix_is_local_pid_dead
2513
 
 
2514
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2515
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2516
 
                      if getattr(errno, name, None) is not None]
2517
 
 
2518
 
 
2519
 
def fdatasync(fileno):
2520
 
    """Flush file contents to disk if possible.
2521
 
    
2522
 
    :param fileno: Integer OS file handle.
2523
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2524
 
    """
2525
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2526
 
    if fn is not None:
2527
 
        try:
2528
 
            fn(fileno)
2529
 
        except IOError as e:
2530
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2531
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2532
 
            # and reduce the chance of corruption-on-powerloss situations. It
2533
 
            # is not a mandatory call, so it is ok to suppress failures.
2534
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2535
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2536
 
                raise
2537
 
 
2538
 
 
2539
 
def ensure_empty_directory_exists(path, exception_class):
2540
 
    """Make sure a local directory exists and is empty.
2541
 
    
2542
 
    If it does not exist, it is created.  If it exists and is not empty, an
2543
 
    instance of exception_class is raised.
2544
 
    """
2545
 
    try:
2546
 
        os.mkdir(path)
2547
 
    except OSError as e:
2548
 
        if e.errno != errno.EEXIST:
2549
 
            raise
2550
 
        if os.listdir(path) != []:
2551
 
            raise exception_class(path)
2552
 
 
2553
 
 
2554
 
def is_environment_error(evalue):
2555
 
    """True if exception instance is due to a process environment issue
2556
 
 
2557
 
    This includes OSError and IOError, but also other errors that come from
2558
 
    the operating system or core libraries but are not subclasses of those.
2559
 
    """
2560
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2561
 
        return True
2562
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2563
 
        return True
2564
 
    return False