/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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
23
21
import sys
24
22
import time
25
23
import codecs
26
24
 
27
 
from .lazy_import import lazy_import
 
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
33
35
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
36
import shutil
38
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
39
40
import socket
40
41
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
42
import tempfile
44
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
45
46
import unicodedata
46
47
 
47
 
from breezy import (
48
 
    config,
 
48
from bzrlib import (
 
49
    cache_utf8,
 
50
    errors,
49
51
    trace,
50
52
    win32utils,
51
53
    )
52
 
from breezy.i18n import gettext
53
54
""")
54
55
 
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
 
    )
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
62
# of 2.5
 
63
if sys.version_info < (2, 5):
 
64
    import md5 as _mod_md5
 
65
    md5 = _mod_md5.new
 
66
    import sha as _mod_sha
 
67
    sha = _mod_sha.new
 
68
else:
 
69
    from hashlib import (
 
70
        md5,
 
71
        sha1 as sha,
 
72
        )
 
73
 
 
74
 
 
75
import bzrlib
 
76
from bzrlib import symbol_versioning
71
77
 
72
78
 
73
79
# Cross platform wall-clock time functionality with decent resolution.
90
96
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
91
97
 
92
98
 
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
99
def get_unicode_argv():
103
 
    if PY3:
104
 
        return sys.argv[1:]
105
100
    try:
106
101
        user_encoding = get_user_encoding()
107
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
108
103
    except UnicodeDecodeError:
109
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
 
                                      "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
111
106
 
112
107
 
113
108
def make_readonly(filename):
114
109
    """Make a filename read-only."""
115
110
    mod = os.lstat(filename).st_mode
116
111
    if not stat.S_ISLNK(mod):
117
 
        mod = mod & 0o777555
118
 
        chmod_if_possible(filename, mod)
 
112
        mod = mod & 0777555
 
113
        os.chmod(filename, mod)
119
114
 
120
115
 
121
116
def make_writable(filename):
122
117
    mod = os.lstat(filename).st_mode
123
118
    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
 
119
        mod = mod | 0200
 
120
        os.chmod(filename, mod)
145
121
 
146
122
 
147
123
def minimum_path_selection(paths):
155
131
        return set(paths)
156
132
 
157
133
    def sort_key(path):
158
 
        if isinstance(path, bytes):
159
 
            return path.split(b'/')
160
 
        else:
161
 
            return path.split('/')
 
134
        return path.split('/')
162
135
    sorted_paths = sorted(list(paths), key=sort_key)
163
136
 
164
137
    search_paths = [sorted_paths[0]]
191
164
 
192
165
_directory_kind = 'directory'
193
166
 
194
 
 
195
167
def get_umask():
196
168
    """Return the current umask"""
197
169
    # Assume that people aren't messing with the umask while running
226
198
            stat = getattr(os, 'lstat', os.stat)
227
199
            stat(f)
228
200
            return True
229
 
        except OSError as e:
 
201
        except OSError, e:
230
202
            if e.errno == errno.ENOENT:
231
 
                return False
 
203
                return False;
232
204
            else:
233
 
                raise errors.BzrError(
234
 
                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
235
206
 
236
207
 
237
208
def fancy_rename(old, new, rename_func, unlink_func):
261
232
    file_existed = False
262
233
    try:
263
234
        rename_func(new, tmp_name)
264
 
    except (errors.NoSuchFile,):
 
235
    except (errors.NoSuchFile,), e:
265
236
        pass
266
 
    except IOError as e:
 
237
    except IOError, e:
267
238
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
268
239
        # function raises an IOError with errno is None when a rename fails.
269
240
        # This then gets caught here.
270
241
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
271
242
            raise
272
 
    except Exception as e:
 
243
    except Exception, e:
273
244
        if (getattr(e, 'errno', None) is None
274
 
                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
245
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
275
246
            raise
276
247
    else:
277
248
        file_existed = True
278
249
 
 
250
    failure_exc = None
279
251
    success = False
280
252
    try:
281
 
        # This may throw an exception, in which case success will
282
 
        # not be set.
283
 
        rename_func(old, new)
284
 
        success = True
285
 
    except (IOError, OSError) as e:
286
 
        # source and target may be aliases of each other (e.g. on a
287
 
        # case-insensitive filesystem), so we may have accidentally renamed
288
 
        # source by when we tried to rename target
289
 
        if (file_existed and e.errno in (None, errno.ENOENT)
 
253
        try:
 
254
            # This may throw an exception, in which case success will
 
255
            # not be set.
 
256
            rename_func(old, new)
 
257
            success = True
 
258
        except (IOError, OSError), e:
 
259
            # source and target may be aliases of each other (e.g. on a
 
260
            # case-insensitive filesystem), so we may have accidentally renamed
 
261
            # source by when we tried to rename target
 
262
            failure_exc = sys.exc_info()
 
263
            if (file_existed and e.errno in (None, errno.ENOENT)
290
264
                and old.lower() == new.lower()):
291
 
            # source and target are the same file on a case-insensitive
292
 
            # filesystem, so we don't generate an exception
293
 
            pass
294
 
        else:
295
 
            raise
 
265
                # source and target are the same file on a case-insensitive
 
266
                # filesystem, so we don't generate an exception
 
267
                failure_exc = None
296
268
    finally:
297
269
        if file_existed:
298
270
            # If the file used to exist, rename it back into place
301
273
                unlink_func(tmp_name)
302
274
            else:
303
275
                rename_func(tmp_name, new)
 
276
    if failure_exc is not None:
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
304
278
 
305
279
 
306
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
307
281
# choke on a Unicode string containing a relative path if
308
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
309
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
310
285
def _posix_abspath(path):
311
286
    # jam 20060426 rather than encoding to fsencoding
312
287
    # copy posixpath.abspath, but use os.getcwdu instead
313
288
    if not posixpath.isabs(path):
314
289
        path = posixpath.join(getcwd(), path)
315
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
316
291
 
317
292
 
318
293
def _posix_realpath(path):
319
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
320
295
 
321
296
 
322
 
def _posix_normpath(path):
323
 
    path = posixpath.normpath(path)
324
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
325
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
326
 
    # leading slashes must not be simplified to one, and only if there are 3 or
327
 
    # more should they be simplified as one. So we treat the leading 2 slashes
328
 
    # as a special case here by simply removing the first slash, as we consider
329
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
330
 
    # This is not a paranoid precaution, as we notably get paths like this when
331
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".
332
 
    if path.startswith('//'):
333
 
        path = path[1:]
334
 
    return path
335
 
 
336
 
 
337
 
def _posix_path_from_environ(key):
338
 
    """Get unicode path from `key` in environment or None if not present
339
 
 
340
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
341
 
    so a path that raises BadFilenameEncoding here may still be accessible.
342
 
    """
343
 
    val = os.environ.get(key, None)
344
 
    if PY3 or val is None:
345
 
        return val
346
 
    try:
347
 
        return val.decode(_fs_enc)
348
 
    except UnicodeDecodeError:
349
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
350
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
351
 
 
352
 
 
353
 
def _posix_get_home_dir():
354
 
    """Get the home directory of the current user as a unicode path"""
355
 
    path = posixpath.expanduser("~")
356
 
    try:
357
 
        return path.decode(_fs_enc)
358
 
    except AttributeError:
359
 
        return path
360
 
    except UnicodeDecodeError:
361
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
362
 
 
363
 
 
364
 
def _posix_getuser_unicode():
365
 
    """Get username from environment or password database as unicode"""
366
 
    name = getpass.getuser()
367
 
    if PY3:
368
 
        return name
369
 
    user_encoding = get_user_encoding()
370
 
    try:
371
 
        return name.decode(user_encoding)
372
 
    except UnicodeDecodeError:
373
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
374
 
                              "application locale." % (name, user_encoding))
375
 
 
376
 
 
377
297
def _win32_fixdrive(path):
378
298
    """Force drive letters to be consistent.
379
299
 
383
303
    running python.exe under cmd.exe return capital C:\\
384
304
    running win32 python inside a cygwin shell returns lowercase c:\\
385
305
    """
386
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
387
307
    return drive.upper() + path
388
308
 
389
309
 
390
310
def _win32_abspath(path):
391
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
392
 
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
313
 
 
314
 
 
315
def _win98_abspath(path):
 
316
    """Return the absolute version of a path.
 
317
    Windows 98 safe implementation (python reimplementation
 
318
    of Win32 API function GetFullPathNameW)
 
319
    """
 
320
    # Corner cases:
 
321
    #   C:\path     => C:/path
 
322
    #   C:/path     => C:/path
 
323
    #   \\HOST\path => //HOST/path
 
324
    #   //HOST/path => //HOST/path
 
325
    #   path        => C:/cwd/path
 
326
    #   /path       => C:/path
 
327
    path = unicode(path)
 
328
    # check for absolute path
 
329
    drive = _nt_splitdrive(path)[0]
 
330
    if drive == '' and path[:2] not in('//','\\\\'):
 
331
        cwd = os.getcwdu()
 
332
        # we cannot simply os.path.join cwd and path
 
333
        # because os.path.join('C:','/path') produce '/path'
 
334
        # and this is incorrect
 
335
        if path[:1] in ('/','\\'):
 
336
            cwd = _nt_splitdrive(cwd)[0]
 
337
            path = path[1:]
 
338
        path = cwd + '\\' + path
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
393
340
 
394
341
 
395
342
def _win32_realpath(path):
396
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
397
 
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
398
345
 
399
346
 
400
347
def _win32_pathjoin(*args):
401
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
402
349
 
403
350
 
404
351
def _win32_normpath(path):
405
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
406
353
 
407
354
 
408
355
def _win32_getcwd():
409
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
356
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
410
357
 
411
358
 
412
359
def _win32_mkdtemp(*args, **kwargs):
413
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
414
361
 
415
362
 
 
363
def _add_rename_error_details(e, old, new):
 
364
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
 
365
        % (old, new, e.strerror))
 
366
    new_e.filename = old
 
367
    new_e.to_filename = new
 
368
    return new_e
 
369
 
 
370
 
416
371
def _win32_rename(old, new):
417
372
    """We expect to be able to atomically replace 'new' with old.
418
373
 
420
375
    and then deleted.
421
376
    """
422
377
    try:
423
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
424
 
    except OSError as e:
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
379
    except OSError, e:
425
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
426
381
            # If we try to rename a non-existant file onto cwd, we get
427
382
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
431
386
        raise
432
387
 
433
388
 
 
389
def _wrapped_rename(old, new):
 
390
    """Rename a file or directory"""
 
391
    try:
 
392
        os.rename(old, new)
 
393
    except (IOError, OSError), e:
 
394
        # this is eventually called by all rename-like functions, so should 
 
395
        # catch all of them
 
396
        raise _add_rename_error_details(e, old, new)
 
397
 
 
398
 
434
399
def _mac_getcwd():
435
 
    return unicodedata.normalize('NFC', _getcwd())
436
 
 
437
 
 
438
 
def _rename_wrap_exception(rename_func):
439
 
    """Adds extra information to any exceptions that come from rename().
440
 
 
441
 
    The exception has an updated message and 'old_filename' and 'new_filename'
442
 
    attributes.
443
 
    """
444
 
 
445
 
    def _rename_wrapper(old, new):
446
 
        try:
447
 
            rename_func(old, new)
448
 
        except OSError as e:
449
 
            detailed_error = OSError(e.errno, e.strerror +
450
 
                                     " [occurred when renaming '%s' to '%s']" %
451
 
                                     (old, new))
452
 
            detailed_error.old_filename = old
453
 
            detailed_error.new_filename = new
454
 
            raise detailed_error
455
 
 
456
 
    return _rename_wrapper
457
 
 
458
 
 
459
 
if sys.version_info > (3,):
460
 
    _getcwd = os.getcwd
461
 
else:
462
 
    _getcwd = os.getcwdu
463
 
 
464
 
 
465
 
# Default rename wraps os.rename()
466
 
rename = _rename_wrap_exception(os.rename)
 
400
    return unicodedata.normalize('NFC', os.getcwdu())
 
401
 
467
402
 
468
403
# Default is to just use the python builtins, but these can be rebound on
469
404
# particular platforms.
470
405
abspath = _posix_abspath
471
406
realpath = _posix_realpath
472
407
pathjoin = os.path.join
473
 
normpath = _posix_normpath
474
 
path_from_environ = _posix_path_from_environ
475
 
_get_home_dir = _posix_get_home_dir
476
 
getuser_unicode = _posix_getuser_unicode
477
 
getcwd = _getcwd
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
 
410
getcwd = os.getcwdu
478
411
dirname = os.path.dirname
479
412
basename = os.path.basename
480
413
split = os.path.split
481
414
splitext = os.path.splitext
482
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
483
416
# mkdtemp = tempfile.mkdtemp
484
417
# rmtree = shutil.rmtree
485
 
lstat = os.lstat
486
 
fstat = os.fstat
487
 
 
488
 
 
489
 
def wrap_stat(st):
490
 
    return st
491
 
 
492
418
 
493
419
MIN_ABS_PATHLENGTH = 1
494
420
 
495
421
 
496
422
if sys.platform == 'win32':
497
 
    abspath = _win32_abspath
 
423
    if win32utils.winver == 'Windows 98':
 
424
        abspath = _win98_abspath
 
425
    else:
 
426
        abspath = _win32_abspath
498
427
    realpath = _win32_realpath
499
428
    pathjoin = _win32_pathjoin
500
429
    normpath = _win32_normpath
501
430
    getcwd = _win32_getcwd
502
431
    mkdtemp = _win32_mkdtemp
503
 
    rename = _rename_wrap_exception(_win32_rename)
504
 
    try:
505
 
        from . import _walkdirs_win32
506
 
    except ImportError:
507
 
        pass
508
 
    else:
509
 
        lstat = _walkdirs_win32.lstat
510
 
        fstat = _walkdirs_win32.fstat
511
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
432
    rename = _win32_rename
512
433
 
513
434
    MIN_ABS_PATHLENGTH = 3
514
435
 
518
439
        """
519
440
        exception = excinfo[1]
520
441
        if function in (os.remove, os.rmdir) \
521
 
                and isinstance(exception, OSError) \
522
 
                and exception.errno == errno.EACCES:
 
442
            and isinstance(exception, OSError) \
 
443
            and exception.errno == errno.EACCES:
523
444
            make_writable(path)
524
445
            function(path)
525
446
        else:
532
453
    f = win32utils.get_unicode_argv     # special function or None
533
454
    if f is not None:
534
455
        get_unicode_argv = f
535
 
    path_from_environ = win32utils.get_environ_unicode
536
 
    _get_home_dir = win32utils.get_home_location
537
 
    getuser_unicode = win32utils.get_user_name
538
456
 
539
457
elif sys.platform == 'darwin':
540
458
    getcwd = _mac_getcwd
541
459
 
542
460
 
543
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
544
462
    """Find the best encoding for printing to the screen.
545
463
 
546
464
    This attempts to check both sys.stdout and sys.stdin to see
552
470
 
553
471
    On my standard US Windows XP, the preferred encoding is
554
472
    cp1252, but the console is cp437
555
 
 
556
 
    :param trace: If True trace the selected encoding via mutter().
557
473
    """
558
 
    from .trace import mutter
 
474
    from bzrlib.trace import mutter
559
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
560
476
    if not output_encoding:
561
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
562
478
        if not input_encoding:
563
479
            output_encoding = get_user_encoding()
564
 
            if trace:
565
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
566
 
                       output_encoding)
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
481
                   output_encoding)
567
482
        else:
568
483
            output_encoding = input_encoding
569
 
            if trace:
570
 
                mutter('encoding stdout as sys.stdin encoding %r',
571
 
                       output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
572
485
    else:
573
 
        if trace:
574
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
575
487
    if output_encoding == 'cp0':
576
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
577
489
        output_encoding = get_user_encoding()
578
 
        if trace:
579
 
            mutter('cp0 is invalid encoding.'
580
 
                   ' encoding stdout as osutils.get_user_encoding() %r',
581
 
                   output_encoding)
 
490
        mutter('cp0 is invalid encoding.'
 
491
               ' encoding stdout as osutils.get_user_encoding() %r',
 
492
               output_encoding)
582
493
    # check encoding
583
494
    try:
584
495
        codecs.lookup(output_encoding)
585
496
    except LookupError:
586
 
        sys.stderr.write('brz: warning:'
 
497
        sys.stderr.write('bzr: warning:'
587
498
                         ' unknown terminal encoding %s.\n'
588
499
                         '  Using encoding %s instead.\n'
589
500
                         % (output_encoding, get_user_encoding())
590
 
                         )
 
501
                        )
591
502
        output_encoding = get_user_encoding()
592
503
 
593
504
    return output_encoding
598
509
        F = realpath
599
510
    else:
600
511
        F = abspath
601
 
    [p, e] = os.path.split(f)
 
512
    [p,e] = os.path.split(f)
602
513
    if e == "" or e == "." or e == "..":
603
514
        return F(f)
604
515
    else:
608
519
def isdir(f):
609
520
    """True if f is an accessible directory."""
610
521
    try:
611
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
612
523
    except OSError:
613
524
        return False
614
525
 
616
527
def isfile(f):
617
528
    """True if f is a regular file."""
618
529
    try:
619
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
620
531
    except OSError:
621
532
        return False
622
533
 
623
 
 
624
534
def islink(f):
625
535
    """True if f is a symlink."""
626
536
    try:
627
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
628
538
    except OSError:
629
539
        return False
630
540
 
631
 
 
632
541
def is_inside(dir, fname):
633
542
    """True if fname is inside dir.
634
543
 
644
553
    if dir == fname:
645
554
        return True
646
555
 
647
 
    if dir in ('', b''):
 
556
    if dir == '':
648
557
        return True
649
558
 
650
 
    if isinstance(dir, bytes):
651
 
        if not dir.endswith(b'/'):
652
 
            dir += b'/'
653
 
    else:
654
 
        if not dir.endswith('/'):
655
 
            dir += '/'
 
559
    if dir[-1] != '/':
 
560
        dir += '/'
656
561
 
657
562
    return fname.startswith(dir)
658
563
 
731
636
    # writes fail on some platforms (e.g. Windows with SMB  mounted
732
637
    # drives).
733
638
    if not segment_size:
734
 
        segment_size = 5242880  # 5MB
735
 
    offsets = range(0, len(bytes), segment_size)
736
 
    view = memoryview(bytes)
 
639
        segment_size = 5242880 # 5MB
 
640
    segments = range(len(bytes) / segment_size + 1)
737
641
    write = file_handle.write
738
 
    for offset in offsets:
739
 
        write(view[offset:offset + segment_size])
 
642
    for segment_index in segments:
 
643
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
644
        write(segment)
740
645
 
741
646
 
742
647
def file_iterator(input_file, readsize=32768):
747
652
        yield b
748
653
 
749
654
 
750
 
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
751
 
# used as bytes through most interfaces so encode with this wrapper.
752
 
if PY3:
753
 
    def _hexdigest(hashobj):
754
 
        return hashobj.hexdigest().encode()
755
 
else:
756
 
    def _hexdigest(hashobj):
757
 
        return hashobj.hexdigest()
758
 
 
759
 
 
760
655
def sha_file(f):
761
656
    """Calculate the hexdigest of an open file.
762
657
 
763
658
    The file cursor should be already at the start.
764
659
    """
765
660
    s = sha()
766
 
    BUFSIZE = 128 << 10
 
661
    BUFSIZE = 128<<10
767
662
    while True:
768
663
        b = f.read(BUFSIZE)
769
664
        if not b:
770
665
            break
771
666
        s.update(b)
772
 
    return _hexdigest(s)
 
667
    return s.hexdigest()
773
668
 
774
669
 
775
670
def size_sha_file(f):
780
675
    """
781
676
    size = 0
782
677
    s = sha()
783
 
    BUFSIZE = 128 << 10
 
678
    BUFSIZE = 128<<10
784
679
    while True:
785
680
        b = f.read(BUFSIZE)
786
681
        if not b:
787
682
            break
788
683
        size += len(b)
789
684
        s.update(b)
790
 
    return size, _hexdigest(s)
 
685
    return size, s.hexdigest()
791
686
 
792
687
 
793
688
def sha_file_by_name(fname):
796
691
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
797
692
    try:
798
693
        while True:
799
 
            b = os.read(f, 1 << 16)
 
694
            b = os.read(f, 1<<16)
800
695
            if not b:
801
 
                return _hexdigest(s)
 
696
                return s.hexdigest()
802
697
            s.update(b)
803
698
    finally:
804
699
        os.close(f)
807
702
def sha_strings(strings, _factory=sha):
808
703
    """Return the sha-1 of concatenation of strings"""
809
704
    s = _factory()
810
 
    for string in strings:
811
 
        s.update(string)
812
 
    return _hexdigest(s)
 
705
    map(s.update, strings)
 
706
    return s.hexdigest()
813
707
 
814
708
 
815
709
def sha_string(f, _factory=sha):
816
 
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
817
 
    return _hexdigest(_factory(f))
 
710
    return _factory(f).hexdigest()
818
711
 
819
712
 
820
713
def fingerprint_file(f):
821
714
    b = f.read()
822
715
    return {'size': len(b),
823
 
            'sha1': _hexdigest(sha(b))}
 
716
            'sha1': sha(b).hexdigest()}
824
717
 
825
718
 
826
719
def compare_files(a, b):
831
724
        bi = b.read(BUFSIZE)
832
725
        if ai != bi:
833
726
            return False
834
 
        if not ai:
 
727
        if ai == '':
835
728
            return True
836
729
 
837
730
 
842
735
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
843
736
    return offset.days * 86400 + offset.seconds
844
737
 
845
 
 
846
738
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
847
739
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
848
740
 
860
752
    :param show_offset: Whether to append the timezone.
861
753
    """
862
754
    (date_fmt, tt, offset_str) = \
863
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
755
               _format_date(t, offset, timezone, date_fmt, show_offset)
864
756
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
865
757
    date_str = time.strftime(date_fmt, tt)
866
758
    return date_str + offset_str
871
763
 
872
764
 
873
765
def format_date_with_offset_in_original_timezone(t, offset=0,
874
 
                                                 _cache=_offset_cache):
 
766
    _cache=_offset_cache):
875
767
    """Return a formatted date string in the original timezone.
876
768
 
877
769
    This routine may be faster then format_date.
904
796
    :param show_offset: Whether to append the timezone.
905
797
    """
906
798
    (date_fmt, tt, offset_str) = \
907
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
799
               _format_date(t, offset, timezone, date_fmt, show_offset)
908
800
    date_str = time.strftime(date_fmt, tt)
909
 
    if not isinstance(date_str, text_type):
 
801
    if not isinstance(date_str, unicode):
910
802
        date_str = date_str.decode(get_user_encoding(), 'replace')
911
803
    return date_str + offset_str
912
804
 
923
815
        tt = time.localtime(t)
924
816
        offset = local_time_offset(t)
925
817
    else:
926
 
        raise UnsupportedTimezoneFormat(timezone)
 
818
        raise errors.UnsupportedTimezoneFormat(timezone)
927
819
    if date_fmt is None:
928
820
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
929
821
    if show_offset:
953
845
        delta = -delta
954
846
 
955
847
    seconds = delta
956
 
    if seconds < 90:  # print seconds up to 90 seconds
 
848
    if seconds < 90: # print seconds up to 90 seconds
957
849
        if seconds == 1:
958
850
            return '%d second %s' % (seconds, direction,)
959
851
        else:
965
857
        plural_seconds = ''
966
858
    else:
967
859
        plural_seconds = 's'
968
 
    if minutes < 90:  # print minutes, seconds up to 90 minutes
 
860
    if minutes < 90: # print minutes, seconds up to 90 minutes
969
861
        if minutes == 1:
970
862
            return '%d minute, %d second%s %s' % (
971
 
                minutes, seconds, plural_seconds, direction)
 
863
                    minutes, seconds, plural_seconds, direction)
972
864
        else:
973
865
            return '%d minutes, %d second%s %s' % (
974
 
                minutes, seconds, plural_seconds, direction)
 
866
                    minutes, seconds, plural_seconds, direction)
975
867
 
976
868
    hours = int(minutes / 60)
977
869
    minutes -= 60 * hours
986
878
    return '%d hours, %d minute%s %s' % (hours, minutes,
987
879
                                         plural_minutes, direction)
988
880
 
989
 
 
990
881
def filesize(f):
991
882
    """Return size of given open file."""
992
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
993
 
 
994
 
 
995
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and
996
 
# override if it doesn't work. Avoid checking on windows where there is
997
 
# significant initialisation cost that can be avoided for some bzr calls.
998
 
 
999
 
rand_bytes = os.urandom
1000
 
 
1001
 
if rand_bytes.__module__ != "nt":
 
883
    return os.fstat(f.fileno())[ST_SIZE]
 
884
 
 
885
 
 
886
# Define rand_bytes based on platform.
 
887
try:
 
888
    # Python 2.4 and later have os.urandom,
 
889
    # but it doesn't work on some arches
 
890
    os.urandom(1)
 
891
    rand_bytes = os.urandom
 
892
except (NotImplementedError, AttributeError):
 
893
    # If python doesn't have os.urandom, or it doesn't work,
 
894
    # then try to first pull random data from /dev/urandom
1002
895
    try:
1003
 
        rand_bytes(1)
1004
 
    except NotImplementedError:
 
896
        rand_bytes = file('/dev/urandom', 'rb').read
 
897
    # Otherwise, use this hack as a last resort
 
898
    except (IOError, OSError):
1005
899
        # not well seeded, but better than nothing
1006
900
        def rand_bytes(n):
1007
901
            import random
1013
907
 
1014
908
 
1015
909
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
1016
 
 
1017
 
 
1018
910
def rand_chars(num):
1019
911
    """Return a random string of num alphanumeric characters
1020
912
 
1023
915
    """
1024
916
    s = ''
1025
917
    for raw_byte in rand_bytes(num):
1026
 
        if not PY3:
1027
 
            s += ALNUM[ord(raw_byte) % 36]
1028
 
        else:
1029
 
            s += ALNUM[raw_byte % 36]
 
918
        s += ALNUM[ord(raw_byte) % 36]
1030
919
    return s
1031
920
 
1032
921
 
1033
 
# TODO: We could later have path objects that remember their list
1034
 
# decomposition (might be too tricksy though.)
 
922
## TODO: We could later have path objects that remember their list
 
923
## decomposition (might be too tricksy though.)
1035
924
 
1036
925
def splitpath(p):
1037
926
    """Turn string into list of parts."""
1038
927
    # split on either delimiter because people might use either on
1039
928
    # Windows
1040
 
    if isinstance(p, bytes):
1041
 
        ps = re.split(b'[\\\\/]', p)
1042
 
    else:
1043
 
        ps = re.split(r'[\\/]', p)
 
929
    ps = re.split(r'[\\/]', p)
1044
930
 
1045
931
    rps = []
1046
932
    for f in ps:
1047
 
        if f in ('..', b'..'):
1048
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
1049
 
        elif f in ('.', '', b'.', b''):
 
933
        if f == '..':
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
935
        elif (f == '.') or (f == ''):
1050
936
            pass
1051
937
        else:
1052
938
            rps.append(f)
1056
942
def joinpath(p):
1057
943
    for f in p:
1058
944
        if (f == '..') or (f is None) or (f == ''):
1059
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1060
946
    return pathjoin(*p)
1061
947
 
1062
948
 
1063
949
def parent_directories(filename):
1064
950
    """Return the list of parent directories, deepest first.
1065
 
 
 
951
    
1066
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1067
953
    """
1068
954
    parents = []
1084
970
    implementation should be loaded instead::
1085
971
 
1086
972
    >>> try:
1087
 
    >>>     import breezy._fictional_extension_pyx
 
973
    >>>     import bzrlib._fictional_extension_pyx
1088
974
    >>> except ImportError, e:
1089
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1090
 
    >>>     import breezy._fictional_extension_py
 
975
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
976
    >>>     import bzrlib._fictional_extension_py
1091
977
    """
1092
978
    # NB: This docstring is just an example, not a doctest, because doctest
1093
979
    # currently can't cope with the use of lazy imports in this namespace --
1094
980
    # mbp 20090729
1095
 
 
 
981
    
1096
982
    # This currently doesn't report the failure at the time it occurs, because
1097
983
    # they tend to happen very early in startup when we can't check config
1098
984
    # files etc, and also we want to report all failures but not spam the user
1099
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1100
987
    exception_str = str(exception)
1101
988
    if exception_str not in _extension_load_failures:
1102
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1106
993
def report_extension_load_failures():
1107
994
    if not _extension_load_failures:
1108
995
        return
1109
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1110
998
        return
1111
999
    # the warnings framework should by default show this only once
1112
 
    from .trace import warning
 
1000
    from bzrlib.trace import warning
1113
1001
    warning(
1114
 
        "brz: warning: some compiled extensions could not be loaded; "
1115
 
        "see ``brz help missing-extensions``")
 
1002
        "bzr: warning: some compiled extensions could not be loaded; "
 
1003
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1116
1004
    # we no longer show the specific missing extensions here, because it makes
1117
1005
    # the message too long and scary - see
1118
1006
    # https://bugs.launchpad.net/bzr/+bug/430529
1119
1007
 
1120
1008
 
1121
1009
try:
1122
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1123
 
except ImportError as e:
 
1010
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1011
except ImportError, e:
1124
1012
    failed_to_load_extension(e)
1125
 
    from ._chunks_to_lines_py import chunks_to_lines
 
1013
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1126
1014
 
1127
1015
 
1128
1016
def split_lines(s):
1129
1017
    """Split s into lines, but without removing the newline characters."""
1130
1018
    # Trivially convert a fulltext into a 'chunked' representation, and let
1131
1019
    # chunks_to_lines do the heavy lifting.
1132
 
    if isinstance(s, bytes):
 
1020
    if isinstance(s, str):
1133
1021
        # chunks_to_lines only supports 8-bit strings
1134
1022
        return chunks_to_lines([s])
1135
1023
    else:
1141
1029
 
1142
1030
    This supports Unicode or plain string objects.
1143
1031
    """
1144
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1145
 
    lines = s.split(nl)
1146
 
    result = [line + nl for line in lines[:-1]]
 
1032
    lines = s.split('\n')
 
1033
    result = [line + '\n' for line in lines[:-1]]
1147
1034
    if lines[-1]:
1148
1035
        result.append(lines[-1])
1149
1036
    return result
1160
1047
        return
1161
1048
    try:
1162
1049
        os.link(src, dest)
1163
 
    except (OSError, IOError) as e:
 
1050
    except (OSError, IOError), e:
1164
1051
        if e.errno != errno.EXDEV:
1165
1052
            raise
1166
1053
        shutil.copyfile(src, dest)
1167
1054
 
1168
1055
 
1169
1056
def delete_any(path):
1170
 
    """Delete a file, symlink or directory.
1171
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1172
1059
    Will delete even if readonly.
1173
1060
    """
1174
1061
    try:
1175
 
        _delete_file_or_dir(path)
1176
 
    except (OSError, IOError) as e:
 
1062
       _delete_file_or_dir(path)
 
1063
    except (OSError, IOError), e:
1177
1064
        if e.errno in (errno.EPERM, errno.EACCES):
1178
1065
            # make writable and try again
1179
1066
            try:
1191
1078
    # - root can damage a solaris file system by using unlink,
1192
1079
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1193
1080
    #   EACCES, OSX: EPERM) when invoked on a directory.
1194
 
    if isdir(path):  # Takes care of symlinks
 
1081
    if isdir(path): # Takes care of symlinks
1195
1082
        os.rmdir(path)
1196
1083
    else:
1197
1084
        os.unlink(path)
1239
1126
    #    separators
1240
1127
    # 3) '\xa0' isn't unicode safe since it is >128.
1241
1128
 
1242
 
    if isinstance(s, str):
1243
 
        ws = ' \t\n\r\v\f'
1244
 
    else:
1245
 
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
1246
 
    for ch in ws:
 
1129
    # This should *not* be a unicode set of characters in case the source
 
1130
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1131
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1132
    # is utf-8
 
1133
    for ch in ' \t\n\r\v\f':
1247
1134
        if ch in s:
1248
1135
            return True
1249
1136
    else:
1275
1162
 
1276
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1277
1164
        # must have space for e.g. a drive letter
1278
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
1279
 
                         % (base,))
 
1165
        raise ValueError('%r is too short to calculate a relative path'
 
1166
            % (base,))
1280
1167
 
1281
1168
    rp = abspath(path)
1282
1169
 
1327
1214
        lbit = bit.lower()
1328
1215
        try:
1329
1216
            next_entries = _listdir(current)
1330
 
        except OSError:  # enoent, eperm, etc
 
1217
        except OSError: # enoent, eperm, etc
1331
1218
            # We can't find this in the filesystem, so just append the
1332
1219
            # remaining bits.
1333
1220
            current = pathjoin(current, bit, *list(bit_iter))
1344
1231
            break
1345
1232
    return current[len(abs_base):].lstrip('/')
1346
1233
 
1347
 
 
1348
1234
# XXX - TODO - we need better detection/integration of case-insensitive
1349
1235
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1350
1236
# filesystems), for example, so could probably benefit from the same basic
1355
1241
else:
1356
1242
    canonical_relpath = relpath
1357
1243
 
1358
 
 
1359
1244
def canonical_relpaths(base, paths):
1360
1245
    """Create an iterable to canonicalize a sequence of relative paths.
1361
1246
 
1365
1250
    # but for now, we haven't optimized...
1366
1251
    return [canonical_relpath(base, p) for p in paths]
1367
1252
 
1368
 
 
1369
 
def decode_filename(filename):
1370
 
    """Decode the filename using the filesystem encoding
1371
 
 
1372
 
    If it is unicode, it is returned.
1373
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1374
 
    fails, a errors.BadFilenameEncoding exception is raised.
1375
 
    """
1376
 
    if isinstance(filename, text_type):
1377
 
        return filename
1378
 
    try:
1379
 
        return filename.decode(_fs_enc)
1380
 
    except UnicodeDecodeError:
1381
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1382
 
 
1383
 
 
1384
1253
def safe_unicode(unicode_or_utf8_string):
1385
1254
    """Coerce unicode_or_utf8_string into unicode.
1386
1255
 
1388
1257
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1389
1258
    wrapped in a BzrBadParameterNotUnicode exception.
1390
1259
    """
1391
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1260
    if isinstance(unicode_or_utf8_string, unicode):
1392
1261
        return unicode_or_utf8_string
1393
1262
    try:
1394
1263
        return unicode_or_utf8_string.decode('utf8')
1402
1271
    If it is a str, it is returned.
1403
1272
    If it is Unicode, it is encoded into a utf-8 string.
1404
1273
    """
1405
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1274
    if isinstance(unicode_or_utf8_string, str):
1406
1275
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1407
1276
        #       performance if we are dealing with lots of apis that want a
1408
1277
        #       utf-8 revision id
1415
1284
    return unicode_or_utf8_string.encode('utf-8')
1416
1285
 
1417
1286
 
1418
 
def safe_revision_id(unicode_or_utf8_string):
 
1287
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1288
                        ' Revision id generators should be creating utf8'
 
1289
                        ' revision ids.')
 
1290
 
 
1291
 
 
1292
def safe_revision_id(unicode_or_utf8_string, warn=True):
1419
1293
    """Revision ids should now be utf8, but at one point they were unicode.
1420
1294
 
1421
1295
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1422
1296
        utf8 or None).
 
1297
    :param warn: Functions that are sanitizing user data can set warn=False
1423
1298
    :return: None or a utf8 revision id.
1424
1299
    """
1425
1300
    if (unicode_or_utf8_string is None
1426
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1301
        or unicode_or_utf8_string.__class__ == str):
1427
1302
        return unicode_or_utf8_string
1428
 
    raise TypeError('Unicode revision ids are no longer supported. '
1429
 
                    'Revision id generators should be creating utf8 revision '
1430
 
                    'ids.')
1431
 
 
1432
 
 
1433
 
def safe_file_id(unicode_or_utf8_string):
 
1303
    if warn:
 
1304
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1305
                               stacklevel=2)
 
1306
    return cache_utf8.encode(unicode_or_utf8_string)
 
1307
 
 
1308
 
 
1309
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1310
                    ' generators should be creating utf8 file ids.')
 
1311
 
 
1312
 
 
1313
def safe_file_id(unicode_or_utf8_string, warn=True):
1434
1314
    """File ids should now be utf8, but at one point they were unicode.
1435
1315
 
1436
1316
    This is the same as safe_utf8, except it uses the cached encode functions
1438
1318
 
1439
1319
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1440
1320
        utf8 or None).
 
1321
    :param warn: Functions that are sanitizing user data can set warn=False
1441
1322
    :return: None or a utf8 file id.
1442
1323
    """
1443
1324
    if (unicode_or_utf8_string is None
1444
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1325
        or unicode_or_utf8_string.__class__ == str):
1445
1326
        return unicode_or_utf8_string
1446
 
    raise TypeError('Unicode file ids are no longer supported. '
1447
 
                    'File id generators should be creating utf8 file ids.')
 
1327
    if warn:
 
1328
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1329
                               stacklevel=2)
 
1330
    return cache_utf8.encode(unicode_or_utf8_string)
1448
1331
 
1449
1332
 
1450
1333
_platform_normalizes_filenames = False
1455
1338
def normalizes_filenames():
1456
1339
    """Return True if this platform normalizes unicode filenames.
1457
1340
 
1458
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1459
1342
    """
1460
1343
    return _platform_normalizes_filenames
1461
1344
 
1466
1349
    On platforms where the system normalizes filenames (Mac OSX),
1467
1350
    you can access a file by any path which will normalize correctly.
1468
1351
    On platforms where the system does not normalize filenames
1469
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1470
1353
 
1471
1354
    Internally, bzr only supports NFC normalization, since that is
1472
1355
    the standard for XML documents.
1475
1358
    can be accessed by that path.
1476
1359
    """
1477
1360
 
1478
 
    if isinstance(path, bytes):
1479
 
        path = path.decode(sys.getfilesystemencoding())
1480
 
    return unicodedata.normalize('NFC', path), True
 
1361
    return unicodedata.normalize('NFC', unicode(path)), True
1481
1362
 
1482
1363
 
1483
1364
def _inaccessible_normalized_filename(path):
1484
1365
    __doc__ = _accessible_normalized_filename.__doc__
1485
1366
 
1486
 
    if isinstance(path, bytes):
1487
 
        path = path.decode(sys.getfilesystemencoding())
1488
 
    normalized = unicodedata.normalize('NFC', path)
 
1367
    normalized = unicodedata.normalize('NFC', unicode(path))
1489
1368
    return normalized, normalized == path
1490
1369
 
1491
1370
 
1514
1393
    except AttributeError:
1515
1394
        # siginterrupt doesn't exist on this platform, or for this version
1516
1395
        # of Python.
1517
 
        def siginterrupt(signum, flag): return None
 
1396
        siginterrupt = lambda signum, flag: None
1518
1397
    if restart_syscall:
1519
1398
        def sig_handler(*args):
1520
1399
            # Python resets the siginterrupt flag when a signal is
1538
1417
terminal_width() returns None.
1539
1418
"""
1540
1419
 
1541
 
# Keep some state so that terminal_width can detect if _terminal_size has
1542
 
# returned a different size since the process started.  See docstring and
1543
 
# comments of terminal_width for details.
1544
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1545
 
_terminal_size_state = 'no_data'
1546
 
_first_terminal_size = None
1547
 
 
1548
1420
 
1549
1421
def terminal_width():
1550
1422
    """Return terminal width.
1552
1424
    None is returned if the width can't established precisely.
1553
1425
 
1554
1426
    The rules are:
1555
 
    - if BRZ_COLUMNS is set, returns its value
 
1427
    - if BZR_COLUMNS is set, returns its value
1556
1428
    - if there is no controlling terminal, returns None
1557
 
    - query the OS, if the queried size has changed since the last query,
1558
 
      return its value,
1559
1429
    - if COLUMNS is set, returns its value,
1560
 
    - if the OS has a value (even though it's never changed), return its value.
1561
1430
 
1562
1431
    From there, we need to query the OS to get the size of the controlling
1563
1432
    terminal.
1564
1433
 
1565
 
    On Unices we query the OS by:
 
1434
    Unices:
1566
1435
    - get termios.TIOCGWINSZ
1567
1436
    - if an error occurs or a negative value is obtained, returns None
1568
1437
 
1569
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1570
1440
    - win32utils.get_console_size() decides,
1571
1441
    - returns None on error (provided default value)
1572
1442
    """
1573
 
    # Note to implementors: if changing the rules for determining the width,
1574
 
    # make sure you've considered the behaviour in these cases:
1575
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1576
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1577
 
    #    0,0.
1578
 
    #  - (add more interesting cases here, if you find any)
1579
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1580
 
    # but we don't want to register a signal handler because it is impossible
1581
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1582
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1583
 
    # time so we can notice if the reported size has changed, which should have
1584
 
    # a similar effect.
1585
1443
 
1586
 
    # If BRZ_COLUMNS is set, take it, user is always right
1587
 
    # Except if they specified 0 in which case, impose no limit here
 
1444
    # If BZR_COLUMNS is set, take it, user is always right
1588
1445
    try:
1589
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1590
1447
    except (KeyError, ValueError):
1591
 
        width = None
1592
 
    if width is not None:
1593
 
        if width > 0:
1594
 
            return width
1595
 
        else:
1596
 
            return None
 
1448
        pass
1597
1449
 
1598
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1599
 
    if isatty is None or not isatty():
1600
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1451
    if  isatty is None or not isatty():
 
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1601
1453
        return None
1602
1454
 
1603
 
    # Query the OS
1604
 
    width, height = os_size = _terminal_size(None, None)
1605
 
    global _first_terminal_size, _terminal_size_state
1606
 
    if _terminal_size_state == 'no_data':
1607
 
        _first_terminal_size = os_size
1608
 
        _terminal_size_state = 'unchanged'
1609
 
    elif (_terminal_size_state == 'unchanged' and
1610
 
          _first_terminal_size != os_size):
1611
 
        _terminal_size_state = 'changed'
1612
 
 
1613
 
    # If the OS claims to know how wide the terminal is, and this value has
1614
 
    # ever changed, use that.
1615
 
    if _terminal_size_state == 'changed':
1616
 
        if width is not None and width > 0:
1617
 
            return width
1618
 
 
1619
 
    # If COLUMNS is set, use it.
 
1455
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1456
    # given terminal, the application can decide to set COLUMNS to a lower
 
1457
    # value (splitted screen) or a bigger value (scroll bars))
1620
1458
    try:
1621
1459
        return int(os.environ['COLUMNS'])
1622
1460
    except (KeyError, ValueError):
1623
1461
        pass
1624
1462
 
1625
 
    # Finally, use an unchanged size from the OS, if we have one.
1626
 
    if _terminal_size_state == 'unchanged':
1627
 
        if width is not None and width > 0:
1628
 
            return width
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1629
1467
 
1630
 
    # The width could not be determined.
1631
 
    return None
 
1468
    return width
1632
1469
 
1633
1470
 
1634
1471
def _win32_terminal_size(width, height):
1635
 
    width, height = win32utils.get_console_size(
1636
 
        defaultx=width, defaulty=height)
 
1472
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1637
1473
    return width, height
1638
1474
 
1639
1475
 
1640
1476
def _ioctl_terminal_size(width, height):
1641
1477
    try:
1642
 
        import struct
1643
 
        import fcntl
1644
 
        import termios
 
1478
        import struct, fcntl, termios
1645
1479
        s = struct.pack('HHHH', 0, 0, 0, 0)
1646
1480
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1647
1481
        height, width = struct.unpack('HHHH', x)[0:2]
1649
1483
        pass
1650
1484
    return width, height
1651
1485
 
1652
 
 
1653
1486
_terminal_size = None
1654
1487
"""Returns the terminal size as (width, height).
1655
1488
 
1665
1498
    _terminal_size = _ioctl_terminal_size
1666
1499
 
1667
1500
 
 
1501
def _terminal_size_changed(signum, frame):
 
1502
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1503
    width, height = _terminal_size(None, None)
 
1504
    if width is not None:
 
1505
        os.environ['COLUMNS'] = str(width)
 
1506
 
 
1507
 
 
1508
_registered_sigwinch = False
 
1509
def watch_sigwinch():
 
1510
    """Register for SIGWINCH, once and only once.
 
1511
 
 
1512
    Do nothing if the signal module is not available.
 
1513
    """
 
1514
    global _registered_sigwinch
 
1515
    if not _registered_sigwinch:
 
1516
        try:
 
1517
            import signal
 
1518
            if getattr(signal, "SIGWINCH", None) is not None:
 
1519
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1520
        except ImportError:
 
1521
            # python doesn't provide signal support, nothing we can do about it
 
1522
            pass
 
1523
        _registered_sigwinch = True
 
1524
 
 
1525
 
1668
1526
def supports_executable():
1669
1527
    return sys.platform != "win32"
1670
1528
 
1695
1553
        if orig_val is not None:
1696
1554
            del os.environ[env_variable]
1697
1555
    else:
1698
 
        if not PY3 and isinstance(value, text_type):
 
1556
        if isinstance(value, unicode):
1699
1557
            value = value.encode(get_user_encoding())
1700
1558
        os.environ[env_variable] = value
1701
1559
    return orig_val
1715
1573
        raise errors.IllegalPath(path)
1716
1574
 
1717
1575
 
1718
 
_WIN32_ERROR_DIRECTORY = 267  # Similar to errno.ENOTDIR
1719
 
 
 
1576
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1720
1577
 
1721
1578
def _is_error_enotdir(e):
1722
1579
    """Check if this exception represents ENOTDIR.
1734
1591
    :return: True if this represents an ENOTDIR error. False otherwise.
1735
1592
    """
1736
1593
    en = getattr(e, 'errno', None)
1737
 
    if (en == errno.ENOTDIR or
1738
 
        (sys.platform == 'win32' and
1739
 
            (en == _WIN32_ERROR_DIRECTORY or
1740
 
             (en == errno.EINVAL
1741
 
              and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1742
 
             ))):
 
1594
    if (en == errno.ENOTDIR
 
1595
        or (sys.platform == 'win32'
 
1596
            and (en == _WIN32_ERROR_DIRECTORY
 
1597
                 or (en == errno.EINVAL
 
1598
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1599
        ))):
1743
1600
        return True
1744
1601
    return False
1745
1602
 
1772
1629
        rooted higher up.
1773
1630
    :return: an iterator over the dirs.
1774
1631
    """
1775
 
    # TODO there is a bit of a smell where the results of the directory-
 
1632
    #TODO there is a bit of a smell where the results of the directory-
1776
1633
    # summary in this, and the path from the root, may not agree
1777
1634
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1778
1635
    # potentially confusing output. We should make this more robust - but
1794
1651
        dirblock = []
1795
1652
        append = dirblock.append
1796
1653
        try:
1797
 
            names = sorted(map(decode_filename, _listdir(top)))
1798
 
        except OSError as e:
 
1654
            names = sorted(_listdir(top))
 
1655
        except OSError, e:
1799
1656
            if not _is_error_enotdir(e):
1800
1657
                raise
1801
1658
        else:
1854
1711
    """
1855
1712
    global _selected_dir_reader
1856
1713
    if _selected_dir_reader is None:
1857
 
        if sys.platform == "win32":
 
1714
        fs_encoding = _fs_enc.upper()
 
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1717
            # TODO: We possibly could support Win98 by falling back to the
 
1718
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1719
            #       but that gets a bit tricky, and requires custom compiling
 
1720
            #       for win98 anyway.
1858
1721
            try:
1859
 
                from ._walkdirs_win32 import Win32ReadDir
 
1722
                from bzrlib._walkdirs_win32 import Win32ReadDir
1860
1723
                _selected_dir_reader = Win32ReadDir()
1861
1724
            except ImportError:
1862
1725
                pass
1863
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1726
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1727
            # ANSI_X3.4-1968 is a form of ASCII
1864
1728
            try:
1865
 
                from ._readdir_pyx import UTF8DirReader
 
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1866
1730
                _selected_dir_reader = UTF8DirReader()
1867
 
            except ImportError as e:
 
1731
            except ImportError, e:
1868
1732
                failed_to_load_extension(e)
1869
1733
                pass
1870
1734
 
1915
1779
        See DirReader.read_dir for details.
1916
1780
        """
1917
1781
        _utf8_encode = self._utf8_encode
1918
 
 
1919
 
        def _fs_decode(s): return s.decode(_fs_enc)
1920
 
 
1921
 
        def _fs_encode(s): return s.encode(_fs_enc)
1922
1782
        _lstat = os.lstat
1923
1783
        _listdir = os.listdir
1924
1784
        _kind_from_mode = file_kind_from_stat_mode
1925
1785
 
1926
1786
        if prefix:
1927
 
            relprefix = prefix + b'/'
 
1787
            relprefix = prefix + '/'
1928
1788
        else:
1929
 
            relprefix = b''
1930
 
        top_slash = top + '/'
 
1789
            relprefix = ''
 
1790
        top_slash = top + u'/'
1931
1791
 
1932
1792
        dirblock = []
1933
1793
        append = dirblock.append
1934
 
        for name_native in _listdir(top.encode('utf-8')):
 
1794
        for name in sorted(_listdir(top)):
1935
1795
            try:
1936
 
                name = _fs_decode(name_native)
 
1796
                name_utf8 = _utf8_encode(name)[0]
1937
1797
            except UnicodeDecodeError:
1938
1798
                raise errors.BadFilenameEncoding(
1939
 
                    relprefix + name_native, _fs_enc)
1940
 
            name_utf8 = _utf8_encode(name)[0]
 
1799
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1941
1800
            abspath = top_slash + name
1942
1801
            statvalue = _lstat(abspath)
1943
1802
            kind = _kind_from_mode(statvalue.st_mode)
1944
1803
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1945
 
        return sorted(dirblock)
 
1804
        return dirblock
1946
1805
 
1947
1806
 
1948
1807
def copy_tree(from_path, to_path, handlers={}):
1973
1832
        link_to = os.readlink(source)
1974
1833
        os.symlink(link_to, dest)
1975
1834
 
1976
 
    real_handlers = {'file': shutil.copy2,
1977
 
                     'symlink': copy_link,
1978
 
                     'directory': copy_dir,
1979
 
                     }
 
1835
    real_handlers = {'file':shutil.copy2,
 
1836
                     'symlink':copy_link,
 
1837
                     'directory':copy_dir,
 
1838
                    }
1980
1839
    real_handlers.update(handlers)
1981
1840
 
1982
1841
    if not os.path.exists(to_path):
1997
1856
    if chown is None:
1998
1857
        return
1999
1858
 
2000
 
    if src is None:
 
1859
    if src == None:
2001
1860
        src = os.path.dirname(dst)
2002
1861
        if src == '':
2003
1862
            src = '.'
2005
1864
    try:
2006
1865
        s = os.stat(src)
2007
1866
        chown(dst, s.st_uid, s.st_gid)
2008
 
    except OSError:
2009
 
        trace.warning(
2010
 
            'Unable to copy ownership from "%s" to "%s". '
2011
 
            'You may want to set it manually.', src, dst)
2012
 
        trace.log_exception_quietly()
 
1867
    except OSError, e:
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
2013
1869
 
2014
1870
 
2015
1871
def path_prefix_key(path):
2017
1873
 
2018
1874
    This can be used to sort paths in the same way that walkdirs does.
2019
1875
    """
2020
 
    return (dirname(path), path)
 
1876
    return (dirname(path) , path)
2021
1877
 
2022
1878
 
2023
1879
def compare_paths_prefix_order(path_a, path_b):
2024
1880
    """Compare path_a and path_b to generate the same order walkdirs uses."""
2025
1881
    key_a = path_prefix_key(path_a)
2026
1882
    key_b = path_prefix_key(path_b)
2027
 
    return (key_a > key_b) - (key_a < key_b)
 
1883
    return cmp(key_a, key_b)
2028
1884
 
2029
1885
 
2030
1886
_cached_user_encoding = None
2031
1887
 
2032
1888
 
2033
 
def get_user_encoding():
 
1889
def get_user_encoding(use_cache=True):
2034
1890
    """Find out what the preferred user encoding is.
2035
1891
 
2036
1892
    This is generally the encoding that is used for command line parameters
2037
1893
    and file contents. This may be different from the terminal encoding
2038
1894
    or the filesystem encoding.
2039
1895
 
 
1896
    :param  use_cache:  Enable cache for detected encoding.
 
1897
                        (This parameter is turned on by default,
 
1898
                        and required only for selftesting)
 
1899
 
2040
1900
    :return: A string defining the preferred user encoding
2041
1901
    """
2042
1902
    global _cached_user_encoding
2043
 
    if _cached_user_encoding is not None:
 
1903
    if _cached_user_encoding is not None and use_cache:
2044
1904
        return _cached_user_encoding
2045
1905
 
2046
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2047
 
        # Use the existing locale settings and call nl_langinfo directly
2048
 
        # rather than going through getpreferredencoding. This avoids
2049
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2050
 
        # possibility of the setlocale call throwing an error.
2051
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1906
    if sys.platform == 'darwin':
 
1907
        # python locale.getpreferredencoding() always return
 
1908
        # 'mac-roman' on darwin. That's a lie.
 
1909
        sys.platform = 'posix'
 
1910
        try:
 
1911
            if os.environ.get('LANG', None) is None:
 
1912
                # If LANG is not set, we end up with 'ascii', which is bad
 
1913
                # ('mac-roman' is more than ascii), so we set a default which
 
1914
                # will give us UTF-8 (which appears to work in all cases on
 
1915
                # OSX). Users are still free to override LANG of course, as
 
1916
                # long as it give us something meaningful. This work-around
 
1917
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1918
                # work with them too -- vila 20080908
 
1919
                os.environ['LANG'] = 'en_US.UTF-8'
 
1920
            import locale
 
1921
        finally:
 
1922
            sys.platform = 'darwin'
2052
1923
    else:
2053
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2054
 
        user_encoding = locale.getpreferredencoding(False)
 
1924
        import locale
2055
1925
 
2056
1926
    try:
2057
 
        user_encoding = codecs.lookup(user_encoding).name
2058
 
    except LookupError:
2059
 
        if user_encoding not in ("", "cp0"):
2060
 
            sys.stderr.write('brz: warning:'
 
1927
        user_encoding = locale.getpreferredencoding()
 
1928
    except locale.Error, e:
 
1929
        sys.stderr.write('bzr: warning: %s\n'
 
1930
                         '  Could not determine what text encoding to use.\n'
 
1931
                         '  This error usually means your Python interpreter\n'
 
1932
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1933
                         "  Continuing with ascii encoding.\n"
 
1934
                         % (e, os.environ.get('LANG')))
 
1935
        user_encoding = 'ascii'
 
1936
 
 
1937
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1938
    # treat that as ASCII, and not support printing unicode characters to the
 
1939
    # console.
 
1940
    #
 
1941
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1942
    if user_encoding in (None, 'cp0', ''):
 
1943
        user_encoding = 'ascii'
 
1944
    else:
 
1945
        # check encoding
 
1946
        try:
 
1947
            codecs.lookup(user_encoding)
 
1948
        except LookupError:
 
1949
            sys.stderr.write('bzr: warning:'
2061
1950
                             ' unknown encoding %s.'
2062
1951
                             ' Continuing with ascii encoding.\n'
2063
1952
                             % user_encoding
2064
 
                             )
2065
 
        user_encoding = 'ascii'
2066
 
    else:
2067
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2068
 
        if user_encoding == 'ascii':
2069
 
            if sys.platform == 'darwin':
2070
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2071
 
                # encoding and previously had LANG set here if not present.
2072
 
                user_encoding = 'utf-8'
2073
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2074
 
            #                for some other posix platforms as well.
2075
 
 
2076
 
    _cached_user_encoding = user_encoding
 
1953
                            )
 
1954
            user_encoding = 'ascii'
 
1955
 
 
1956
    if use_cache:
 
1957
        _cached_user_encoding = user_encoding
 
1958
 
2077
1959
    return user_encoding
2078
1960
 
2079
1961
 
2080
 
def get_diff_header_encoding():
2081
 
    return get_terminal_encoding()
2082
 
 
2083
 
 
2084
1962
def get_host_name():
2085
1963
    """Return the current unicode host name.
2086
1964
 
2088
1966
    behaves inconsistently on different platforms.
2089
1967
    """
2090
1968
    if sys.platform == "win32":
 
1969
        import win32utils
2091
1970
        return win32utils.get_host_name()
2092
1971
    else:
2093
1972
        import socket
2094
 
        if PY3:
2095
 
            return socket.gethostname()
2096
1973
        return socket.gethostname().decode(get_user_encoding())
2097
1974
 
2098
1975
 
2102
1979
# data at once.
2103
1980
MAX_SOCKET_CHUNK = 64 * 1024
2104
1981
 
2105
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2106
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2107
 
    _eno = getattr(errno, _eno, None)
2108
 
    if _eno is not None:
2109
 
        _end_of_stream_errors.append(_eno)
2110
 
del _eno
2111
 
 
2112
 
 
2113
1982
def read_bytes_from_socket(sock, report_activity=None,
2114
 
                           max_read_size=MAX_SOCKET_CHUNK):
 
1983
        max_read_size=MAX_SOCKET_CHUNK):
2115
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2116
1985
 
2117
1986
    Translates "Connection reset by peer" into file-like EOF (return an
2118
1987
    empty string rather than raise an error), and repeats the recv if
2119
1988
    interrupted by a signal.
2120
1989
    """
2121
 
    while True:
 
1990
    while 1:
2122
1991
        try:
2123
 
            data = sock.recv(max_read_size)
2124
 
        except socket.error as e:
 
1992
            bytes = sock.recv(max_read_size)
 
1993
        except socket.error, e:
2125
1994
            eno = e.args[0]
2126
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2127
1996
                # The connection was closed by the other side.  Callers expect
2128
1997
                # an empty string to signal end-of-stream.
2129
 
                return b""
 
1998
                return ""
2130
1999
            elif eno == errno.EINTR:
2131
2000
                # Retry the interrupted recv.
2132
2001
                continue
2133
2002
            raise
2134
2003
        else:
2135
2004
            if report_activity is not None:
2136
 
                report_activity(len(data), 'read')
2137
 
            return data
 
2005
                report_activity(len(bytes), 'read')
 
2006
            return bytes
2138
2007
 
2139
2008
 
2140
2009
def recv_all(socket, count):
2147
2016
 
2148
2017
    This isn't optimized and is intended mostly for use in testing.
2149
2018
    """
2150
 
    b = b''
 
2019
    b = ''
2151
2020
    while len(b) < count:
2152
2021
        new = read_bytes_from_socket(socket, None, count - len(b))
2153
 
        if new == b'':
2154
 
            break  # eof
 
2022
        if new == '':
 
2023
            break # eof
2155
2024
        b += new
2156
2025
    return b
2157
2026
 
2158
2027
 
2159
2028
def send_all(sock, bytes, report_activity=None):
2160
2029
    """Send all bytes on a socket.
2161
 
 
 
2030
 
2162
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2163
2032
    some platforms, and catches EINTR which may be thrown if the send is
2164
2033
    interrupted by a signal.
2165
2034
 
2166
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2167
2036
    and provides activity reporting.
2168
 
 
 
2037
 
2169
2038
    :param report_activity: Call this as bytes are read, see
2170
2039
        Transport._report_activity
2171
2040
    """
2172
2041
    sent_total = 0
2173
2042
    byte_count = len(bytes)
2174
 
    view = memoryview(bytes)
2175
2043
    while sent_total < byte_count:
2176
2044
        try:
2177
 
            sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
2178
 
        except (socket.error, IOError) as e:
2179
 
            if e.args[0] in _end_of_stream_errors:
2180
 
                raise errors.ConnectionReset(
2181
 
                    "Error trying to write to socket", e)
 
2045
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2046
        except socket.error, e:
2182
2047
            if e.args[0] != errno.EINTR:
2183
2048
                raise
2184
2049
        else:
2185
 
            if sent == 0:
2186
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2187
 
                                             % (sock,))
2188
2050
            sent_total += sent
2189
 
            if report_activity is not None:
2190
 
                report_activity(sent, 'write')
2191
 
 
2192
 
 
2193
 
def connect_socket(address):
2194
 
    # Slight variation of the socket.create_connection() function (provided by
2195
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2196
 
    # provide it for previous python versions. Also, we don't use the timeout
2197
 
    # parameter (provided by the python implementation) so we don't implement
2198
 
    # it either).
2199
 
    err = socket.error('getaddrinfo returns an empty list')
2200
 
    host, port = address
2201
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2202
 
        af, socktype, proto, canonname, sa = res
2203
 
        sock = None
2204
 
        try:
2205
 
            sock = socket.socket(af, socktype, proto)
2206
 
            sock.connect(sa)
2207
 
            return sock
2208
 
 
2209
 
        except socket.error as e:
2210
 
            err = e
2211
 
            # 'err' is now the most recent error
2212
 
            if sock is not None:
2213
 
                sock.close()
2214
 
    raise err
 
2051
            report_activity(sent, 'write')
2215
2052
 
2216
2053
 
2217
2054
def dereference_path(path):
2236
2073
def resource_string(package, resource_name):
2237
2074
    """Load a resource from a package and return it as a string.
2238
2075
 
2239
 
    Note: Only packages that start with breezy are currently supported.
 
2076
    Note: Only packages that start with bzrlib are currently supported.
2240
2077
 
2241
2078
    This is designed to be a lightweight implementation of resource
2242
2079
    loading in a way which is API compatible with the same API from
2245
2082
    If and when pkg_resources becomes a standard library, this routine
2246
2083
    can delegate to it.
2247
2084
    """
2248
 
    # Check package name is within breezy
2249
 
    if package == "breezy":
 
2085
    # Check package name is within bzrlib
 
2086
    if package == "bzrlib":
2250
2087
        resource_relpath = resource_name
2251
 
    elif package.startswith("breezy."):
2252
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2088
    elif package.startswith("bzrlib."):
 
2089
        package = package[len("bzrlib."):].replace('.', os.sep)
2253
2090
        resource_relpath = pathjoin(package, resource_name)
2254
2091
    else:
2255
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2092
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2256
2093
 
2257
2094
    # Map the resource to a file and read its contents
2258
 
    base = dirname(breezy.__file__)
 
2095
    base = dirname(bzrlib.__file__)
2259
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2260
2097
        base = abspath(pathjoin(base, '..', '..'))
2261
 
    with open(pathjoin(base, resource_relpath), "rt") as f:
2262
 
        return f.read()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
2263
2100
 
2264
2101
 
2265
2102
def file_kind_from_stat_mode_thunk(mode):
2266
2103
    global file_kind_from_stat_mode
2267
2104
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2268
2105
        try:
2269
 
            from ._readdir_pyx import UTF8DirReader
 
2106
            from bzrlib._readdir_pyx import UTF8DirReader
2270
2107
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2271
 
        except ImportError:
 
2108
        except ImportError, e:
2272
2109
            # This is one time where we won't warn that an extension failed to
2273
2110
            # load. The extension is never available on Windows anyway.
2274
 
            from ._readdir_py import (
 
2111
            from bzrlib._readdir_py import (
2275
2112
                _kind_from_mode as file_kind_from_stat_mode
2276
2113
                )
2277
2114
    return file_kind_from_stat_mode(mode)
2278
 
 
2279
 
 
2280
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2281
2116
 
2282
2117
 
2283
 
def file_stat(f, _lstat=os.lstat):
 
2118
def file_kind(f, _lstat=os.lstat):
2284
2119
    try:
2285
 
        # XXX cache?
2286
 
        return _lstat(f)
2287
 
    except OSError as e:
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2121
    except OSError, e:
2288
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2289
2123
            raise errors.NoSuchFile(f)
2290
2124
        raise
2291
2125
 
2292
2126
 
2293
 
def file_kind(f, _lstat=os.lstat):
2294
 
    stat_value = file_stat(f, _lstat)
2295
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2296
 
 
2297
 
 
2298
2127
def until_no_eintr(f, *a, **kw):
2299
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2300
 
 
 
2129
    
2301
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2302
2131
    if EINTR does occur.  This is typically only true for low-level operations
2303
2132
    like os.read.  If in any doubt, don't use this.
2305
2134
    Keep in mind that this is not a complete solution to EINTR.  There is
2306
2135
    probably code in the Python standard library and other dependencies that
2307
2136
    may encounter EINTR if a signal arrives (and there is signal handler for
2308
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2137
    that signal).  So this function can reduce the impact for IO that bzrlib
2309
2138
    directly controls, but it is not a complete solution.
2310
2139
    """
2311
2140
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2312
2141
    while True:
2313
2142
        try:
2314
2143
            return f(*a, **kw)
2315
 
        except (IOError, OSError) as e:
 
2144
        except (IOError, OSError), e:
2316
2145
            if e.errno == errno.EINTR:
2317
2146
                continue
2318
2147
            raise
2319
2148
 
2320
2149
 
 
2150
def re_compile_checked(re_string, flags=0, where=""):
 
2151
    """Return a compiled re, or raise a sensible error.
 
2152
 
 
2153
    This should only be used when compiling user-supplied REs.
 
2154
 
 
2155
    :param re_string: Text form of regular expression.
 
2156
    :param flags: eg re.IGNORECASE
 
2157
    :param where: Message explaining to the user the context where
 
2158
        it occurred, eg 'log search filter'.
 
2159
    """
 
2160
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2161
    try:
 
2162
        re_obj = re.compile(re_string, flags)
 
2163
        re_obj.search("")
 
2164
        return re_obj
 
2165
    except re.error, e:
 
2166
        if where:
 
2167
            where = ' in ' + where
 
2168
        # despite the name 'error' is a type
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
 
2171
 
 
2172
 
2321
2173
if sys.platform == "win32":
 
2174
    import msvcrt
2322
2175
    def getchar():
2323
 
        import msvcrt
2324
2176
        return msvcrt.getch()
2325
2177
else:
 
2178
    import tty
 
2179
    import termios
2326
2180
    def getchar():
2327
 
        import tty
2328
 
        import termios
2329
2181
        fd = sys.stdin.fileno()
2330
2182
        settings = termios.tcgetattr(fd)
2331
2183
        try:
2335
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2336
2188
        return ch
2337
2189
 
2338
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2339
2192
    def _local_concurrency():
2340
 
        try:
2341
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2342
 
        except (ValueError, OSError, AttributeError):
2343
 
            return None
 
2193
        concurrency = None
 
2194
        prefix = 'processor'
 
2195
        for line in file('/proc/cpuinfo', 'rb'):
 
2196
            if line.startswith(prefix):
 
2197
                concurrency = int(line[line.find(':')+1:]) + 1
 
2198
        return concurrency
2344
2199
elif sys.platform == 'darwin':
2345
2200
    def _local_concurrency():
2346
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2347
2202
                                stdout=subprocess.PIPE).communicate()[0]
2348
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2349
2204
    def _local_concurrency():
2350
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2351
2206
                                stdout=subprocess.PIPE).communicate()[0]
2352
2207
elif sys.platform == 'sunos5':
2353
2208
    def _local_concurrency():
2354
 
        return subprocess.Popen(['psrinfo', '-p', ],
 
2209
        return subprocess.Popen(['psrinfo', '-p',],
2355
2210
                                stdout=subprocess.PIPE).communicate()[0]
2356
2211
elif sys.platform == "win32":
2357
2212
    def _local_concurrency():
2365
2220
 
2366
2221
_cached_local_concurrency = None
2367
2222
 
2368
 
 
2369
2223
def local_concurrency(use_cache=True):
2370
2224
    """Return how many processes can be run concurrently.
2371
2225
 
2377
2231
    if _cached_local_concurrency is not None and use_cache:
2378
2232
        return _cached_local_concurrency
2379
2233
 
2380
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2381
2235
    if concurrency is None:
2382
 
        import multiprocessing
2383
2236
        try:
2384
 
            concurrency = multiprocessing.cpu_count()
2385
 
        except NotImplementedError:
2386
 
            # multiprocessing.cpu_count() isn't implemented on all platforms
2387
 
            try:
2388
 
                concurrency = _local_concurrency()
2389
 
            except (OSError, IOError):
2390
 
                pass
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2391
2240
    try:
2392
2241
        concurrency = int(concurrency)
2393
2242
    except (TypeError, ValueError):
2394
2243
        concurrency = 1
2395
2244
    if use_cache:
2396
 
        _cached_local_concurrency = concurrency
 
2245
        _cached_concurrency = concurrency
2397
2246
    return concurrency
2398
2247
 
2399
2248
 
2405
2254
        self.encode = encode
2406
2255
 
2407
2256
    def write(self, object):
2408
 
        if isinstance(object, str):
 
2257
        if type(object) is str:
2409
2258
            self.stream.write(object)
2410
2259
        else:
2411
2260
            data, _ = self.encode(object, self.errors)
2412
2261
            self.stream.write(data)
2413
2262
 
2414
 
 
2415
2263
if sys.platform == 'win32':
2416
2264
    def open_file(filename, mode='r', bufsize=-1):
2417
2265
        """This function is used to override the ``open`` builtin.
2418
 
 
 
2266
        
2419
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2420
2268
        child processes.  Deleting or renaming a closed file opened with this
2421
2269
        function is not blocking child processes.
2445
2293
            else:
2446
2294
                flags |= os.O_WRONLY
2447
2295
            flags |= os.O_CREAT | os.O_APPEND
2448
 
        else:  # reading
 
2296
        else: #reading
2449
2297
            if updating:
2450
2298
                flags |= os.O_RDWR
2451
2299
            else:
2454
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2455
2303
else:
2456
2304
    open_file = open
2457
 
 
2458
 
 
2459
 
def available_backup_name(base, exists):
2460
 
    """Find a non-existing backup file name.
2461
 
 
2462
 
    This will *not* create anything, this only return a 'free' entry.  This
2463
 
    should be used for checking names in a directory below a locked
2464
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2465
 
    Leap) and generally discouraged.
2466
 
 
2467
 
    :param base: The base name.
2468
 
 
2469
 
    :param exists: A callable returning True if the path parameter exists.
2470
 
    """
2471
 
    counter = 1
2472
 
    name = "%s.~%d~" % (base, counter)
2473
 
    while exists(name):
2474
 
        counter += 1
2475
 
        name = "%s.~%d~" % (base, counter)
2476
 
    return name
2477
 
 
2478
 
 
2479
 
def set_fd_cloexec(fd):
2480
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2481
 
    support for this is not available.
2482
 
    """
2483
 
    try:
2484
 
        import fcntl
2485
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2486
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2487
 
    except (ImportError, AttributeError):
2488
 
        # Either the fcntl module or specific constants are not present
2489
 
        pass
2490
 
 
2491
 
 
2492
 
def find_executable_on_path(name):
2493
 
    """Finds an executable on the PATH.
2494
 
 
2495
 
    On Windows, this will try to append each extension in the PATHEXT
2496
 
    environment variable to the name, if it cannot be found with the name
2497
 
    as given.
2498
 
 
2499
 
    :param name: The base name of the executable.
2500
 
    :return: The path to the executable found or None.
2501
 
    """
2502
 
    if sys.platform == 'win32':
2503
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2504
 
        exts = [ext.lower() for ext in exts]
2505
 
        base, ext = os.path.splitext(name)
2506
 
        if ext != '':
2507
 
            if ext.lower() not in exts:
2508
 
                return None
2509
 
            name = base
2510
 
            exts = [ext]
2511
 
    else:
2512
 
        exts = ['']
2513
 
    path = os.environ.get('PATH')
2514
 
    if path is not None:
2515
 
        path = path.split(os.pathsep)
2516
 
        for ext in exts:
2517
 
            for d in path:
2518
 
                f = os.path.join(d, name) + ext
2519
 
                if os.access(f, os.X_OK):
2520
 
                    return f
2521
 
    if sys.platform == 'win32':
2522
 
        app_path = win32utils.get_app_path(name)
2523
 
        if app_path != name:
2524
 
            return app_path
2525
 
    return None
2526
 
 
2527
 
 
2528
 
def _posix_is_local_pid_dead(pid):
2529
 
    """True if pid doesn't correspond to live process on this machine"""
2530
 
    try:
2531
 
        # Special meaning of unix kill: just check if it's there.
2532
 
        os.kill(pid, 0)
2533
 
    except OSError as e:
2534
 
        if e.errno == errno.ESRCH:
2535
 
            # On this machine, and really not found: as sure as we can be
2536
 
            # that it's dead.
2537
 
            return True
2538
 
        elif e.errno == errno.EPERM:
2539
 
            # exists, though not ours
2540
 
            return False
2541
 
        else:
2542
 
            trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2543
 
            # Don't really know.
2544
 
            return False
2545
 
    else:
2546
 
        # Exists and our process: not dead.
2547
 
        return False
2548
 
 
2549
 
 
2550
 
if sys.platform == "win32":
2551
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2552
 
else:
2553
 
    is_local_pid_dead = _posix_is_local_pid_dead
2554
 
 
2555
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2556
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2557
 
                      if getattr(errno, name, None) is not None]
2558
 
 
2559
 
 
2560
 
def fdatasync(fileno):
2561
 
    """Flush file contents to disk if possible.
2562
 
 
2563
 
    :param fileno: Integer OS file handle.
2564
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2565
 
    """
2566
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2567
 
    if fn is not None:
2568
 
        try:
2569
 
            fn(fileno)
2570
 
        except IOError as e:
2571
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2572
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2573
 
            # and reduce the chance of corruption-on-powerloss situations. It
2574
 
            # is not a mandatory call, so it is ok to suppress failures.
2575
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2576
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2577
 
                raise
2578
 
 
2579
 
 
2580
 
def ensure_empty_directory_exists(path, exception_class):
2581
 
    """Make sure a local directory exists and is empty.
2582
 
 
2583
 
    If it does not exist, it is created.  If it exists and is not empty, an
2584
 
    instance of exception_class is raised.
2585
 
    """
2586
 
    try:
2587
 
        os.mkdir(path)
2588
 
    except OSError as e:
2589
 
        if e.errno != errno.EEXIST:
2590
 
            raise
2591
 
        if os.listdir(path) != []:
2592
 
            raise exception_class(path)
2593
 
 
2594
 
 
2595
 
def is_environment_error(evalue):
2596
 
    """True if exception instance is due to a process environment issue
2597
 
 
2598
 
    This includes OSError and IOError, but also other errors that come from
2599
 
    the operating system or core libraries but are not subclasses of those.
2600
 
    """
2601
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2602
 
        return True
2603
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2604
 
        return True
2605
 
    return False