/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Andrew Bennetts
  • Date: 2009-10-21 11:13:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4762.
  • Revision ID: andrew.bennetts@canonical.com-20091021111340-w7x4d5yf83qwjncc
Add test that WSGI glue allows request handlers to access paths above that request's. backing transport, so long as it is within the WSGI app's backing transport.

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, 2006, 2007, 2009 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
 
24
import warnings
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
25
28
import codecs
26
 
 
27
 
from .lazy_import import lazy_import
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
 
import socket
 
39
from shutil import (
 
40
    rmtree,
 
41
    )
40
42
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
43
import tempfile
44
 
from tempfile import mkdtemp
 
44
from tempfile import (
 
45
    mkdtemp,
 
46
    )
45
47
import unicodedata
46
48
 
47
 
from breezy import (
48
 
    config,
49
 
    trace,
 
49
from bzrlib import (
 
50
    cache_utf8,
 
51
    errors,
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
 
    )
71
 
 
72
 
 
73
 
# Cross platform wall-clock time functionality with decent resolution.
74
 
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
75
 
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
76
 
# synchronized with ``time.time()``, this is only meant to be used to find
77
 
# delta times by subtracting from another call to this function.
78
 
timer_func = time.time
79
 
if sys.platform == 'win32':
80
 
    timer_func = time.clock
 
56
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
57
# of 2.5
 
58
if sys.version_info < (2, 5):
 
59
    import md5 as _mod_md5
 
60
    md5 = _mod_md5.new
 
61
    import sha as _mod_sha
 
62
    sha = _mod_sha.new
 
63
else:
 
64
    from hashlib import (
 
65
        md5,
 
66
        sha1 as sha,
 
67
        )
 
68
 
 
69
 
 
70
import bzrlib
 
71
from bzrlib import symbol_versioning
 
72
 
81
73
 
82
74
# On win32, O_BINARY is used to indicate the file should
83
75
# be opened in binary mode, rather than text mode.
84
76
# On other platforms, O_BINARY doesn't exist, because
85
77
# they always open in binary mode, so it is okay to
86
 
# OR with 0 on those platforms.
87
 
# O_NOINHERIT and O_TEXT exists only on win32 too.
 
78
# OR with 0 on those platforms
88
79
O_BINARY = getattr(os, 'O_BINARY', 0)
89
 
O_TEXT = getattr(os, 'O_TEXT', 0)
90
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
91
 
 
92
 
 
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
80
 
101
81
 
102
82
def get_unicode_argv():
103
 
    if PY3:
104
 
        return sys.argv[1:]
105
83
    try:
106
84
        user_encoding = get_user_encoding()
107
85
        return [a.decode(user_encoding) for a in sys.argv[1:]]
108
86
    except UnicodeDecodeError:
109
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
 
            "application locale.").format(a, user_encoding))
 
87
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
88
                                                            "encoding." % a))
111
89
 
112
90
 
113
91
def make_readonly(filename):
114
92
    """Make a filename read-only."""
115
93
    mod = os.lstat(filename).st_mode
116
94
    if not stat.S_ISLNK(mod):
117
 
        mod = mod & 0o777555
118
 
        chmod_if_possible(filename, mod)
 
95
        mod = mod & 0777555
 
96
        os.chmod(filename, mod)
119
97
 
120
98
 
121
99
def make_writable(filename):
122
100
    mod = os.lstat(filename).st_mode
123
101
    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
 
102
        mod = mod | 0200
 
103
        os.chmod(filename, mod)
145
104
 
146
105
 
147
106
def minimum_path_selection(paths):
210
169
    try:
211
170
        return _kind_marker_map[kind]
212
171
    except KeyError:
213
 
        # Slightly faster than using .get(, '') when the common case is that
214
 
        # kind will be found
215
 
        return ''
 
172
        raise errors.BzrError('invalid file kind %r' % kind)
216
173
 
217
174
 
218
175
lexists = getattr(os.path, 'lexists', None)
222
179
            stat = getattr(os, 'lstat', os.stat)
223
180
            stat(f)
224
181
            return True
225
 
        except OSError as e:
 
182
        except OSError, e:
226
183
            if e.errno == errno.ENOENT:
227
184
                return False;
228
185
            else:
229
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
186
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
230
187
 
231
188
 
232
189
def fancy_rename(old, new, rename_func, unlink_func):
235
192
    :param old: The old path, to rename from
236
193
    :param new: The new path, to rename to
237
194
    :param rename_func: The potentially non-atomic rename function
238
 
    :param unlink_func: A way to delete the target file if the full rename
239
 
        succeeds
 
195
    :param unlink_func: A way to delete the target file if the full rename succeeds
240
196
    """
 
197
 
241
198
    # sftp rename doesn't allow overwriting, so play tricks:
242
199
    base = os.path.basename(new)
243
200
    dirname = os.path.dirname(new)
244
 
    # callers use different encodings for the paths so the following MUST
245
 
    # respect that. We rely on python upcasting to unicode if new is unicode
246
 
    # and keeping a str if not.
247
 
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
248
 
                                      os.getpid(), rand_chars(10))
 
201
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
249
202
    tmp_name = pathjoin(dirname, tmp_name)
250
203
 
251
204
    # Rename the file out of the way, but keep track if it didn't exist
256
209
    file_existed = False
257
210
    try:
258
211
        rename_func(new, tmp_name)
259
 
    except (errors.NoSuchFile,) as e:
 
212
    except (errors.NoSuchFile,), e:
260
213
        pass
261
 
    except IOError as e:
 
214
    except IOError, e:
262
215
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
263
216
        # function raises an IOError with errno is None when a rename fails.
264
217
        # This then gets caught here.
265
218
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
266
219
            raise
267
 
    except Exception as e:
 
220
    except Exception, e:
268
221
        if (getattr(e, 'errno', None) is None
269
222
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
270
223
            raise
273
226
 
274
227
    success = False
275
228
    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
 
229
        try:
 
230
            # This may throw an exception, in which case success will
 
231
            # not be set.
 
232
            rename_func(old, new)
 
233
            success = True
 
234
        except (IOError, OSError), e:
 
235
            # source and target may be aliases of each other (e.g. on a
 
236
            # case-insensitive filesystem), so we may have accidentally renamed
 
237
            # source by when we tried to rename target
 
238
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
239
                raise
291
240
    finally:
292
241
        if file_existed:
293
242
            # If the file used to exist, rename it back into place
302
251
# choke on a Unicode string containing a relative path if
303
252
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
304
253
# string.
 
254
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
305
255
def _posix_abspath(path):
306
256
    # jam 20060426 rather than encoding to fsencoding
307
257
    # copy posixpath.abspath, but use os.getcwdu instead
308
258
    if not posixpath.isabs(path):
309
259
        path = posixpath.join(getcwd(), path)
310
 
    return _posix_normpath(path)
 
260
    return posixpath.normpath(path)
311
261
 
312
262
 
313
263
def _posix_realpath(path):
314
264
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
315
265
 
316
266
 
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
267
def _win32_fixdrive(path):
373
268
    """Force drive letters to be consistent.
374
269
 
378
273
    running python.exe under cmd.exe return capital C:\\
379
274
    running win32 python inside a cygwin shell returns lowercase c:\\
380
275
    """
381
 
    drive, path = ntpath.splitdrive(path)
 
276
    drive, path = _nt_splitdrive(path)
382
277
    return drive.upper() + path
383
278
 
384
279
 
385
280
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('\\', '/'))
 
281
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
282
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
283
 
 
284
 
 
285
def _win98_abspath(path):
 
286
    """Return the absolute version of a path.
 
287
    Windows 98 safe implementation (python reimplementation
 
288
    of Win32 API function GetFullPathNameW)
 
289
    """
 
290
    # Corner cases:
 
291
    #   C:\path     => C:/path
 
292
    #   C:/path     => C:/path
 
293
    #   \\HOST\path => //HOST/path
 
294
    #   //HOST/path => //HOST/path
 
295
    #   path        => C:/cwd/path
 
296
    #   /path       => C:/path
 
297
    path = unicode(path)
 
298
    # check for absolute path
 
299
    drive = _nt_splitdrive(path)[0]
 
300
    if drive == '' and path[:2] not in('//','\\\\'):
 
301
        cwd = os.getcwdu()
 
302
        # we cannot simply os.path.join cwd and path
 
303
        # because os.path.join('C:','/path') produce '/path'
 
304
        # and this is incorrect
 
305
        if path[:1] in ('/','\\'):
 
306
            cwd = _nt_splitdrive(cwd)[0]
 
307
            path = path[1:]
 
308
        path = cwd + '\\' + path
 
309
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
388
310
 
389
311
 
390
312
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('\\', '/'))
 
313
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
314
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
393
315
 
394
316
 
395
317
def _win32_pathjoin(*args):
396
 
    return ntpath.join(*args).replace('\\', '/')
 
318
    return _nt_join(*args).replace('\\', '/')
397
319
 
398
320
 
399
321
def _win32_normpath(path):
400
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
322
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
401
323
 
402
324
 
403
325
def _win32_getcwd():
404
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
326
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
405
327
 
406
328
 
407
329
def _win32_mkdtemp(*args, **kwargs):
416
338
    """
417
339
    try:
418
340
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
419
 
    except OSError as e:
 
341
    except OSError, e:
420
342
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
421
343
            # If we try to rename a non-existant file onto cwd, we get
422
344
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
427
349
 
428
350
 
429
351
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)
 
352
    return unicodedata.normalize('NFC', os.getcwdu())
 
353
 
462
354
 
463
355
# Default is to just use the python builtins, but these can be rebound on
464
356
# particular platforms.
465
357
abspath = _posix_abspath
466
358
realpath = _posix_realpath
467
359
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
 
360
normpath = os.path.normpath
 
361
getcwd = os.getcwdu
 
362
rename = os.rename
473
363
dirname = os.path.dirname
474
364
basename = os.path.basename
475
365
split = os.path.split
476
366
splitext = os.path.splitext
477
 
# These were already lazily imported into local scope
 
367
# These were already imported into local scope
478
368
# mkdtemp = tempfile.mkdtemp
479
369
# rmtree = shutil.rmtree
480
 
lstat = os.lstat
481
 
fstat = os.fstat
482
 
 
483
 
def wrap_stat(st):
484
 
    return st
485
 
 
486
370
 
487
371
MIN_ABS_PATHLENGTH = 1
488
372
 
489
373
 
490
374
if sys.platform == 'win32':
491
 
    abspath = _win32_abspath
 
375
    if win32utils.winver == 'Windows 98':
 
376
        abspath = _win98_abspath
 
377
    else:
 
378
        abspath = _win32_abspath
492
379
    realpath = _win32_realpath
493
380
    pathjoin = _win32_pathjoin
494
381
    normpath = _win32_normpath
495
382
    getcwd = _win32_getcwd
496
383
    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
 
384
    rename = _win32_rename
506
385
 
507
386
    MIN_ABS_PATHLENGTH = 3
508
387
 
526
405
    f = win32utils.get_unicode_argv     # special function or None
527
406
    if f is not None:
528
407
        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
408
 
533
409
elif sys.platform == 'darwin':
534
410
    getcwd = _mac_getcwd
535
411
 
536
412
 
537
 
def get_terminal_encoding(trace=False):
 
413
def get_terminal_encoding():
538
414
    """Find the best encoding for printing to the screen.
539
415
 
540
416
    This attempts to check both sys.stdout and sys.stdin to see
546
422
 
547
423
    On my standard US Windows XP, the preferred encoding is
548
424
    cp1252, but the console is cp437
549
 
 
550
 
    :param trace: If True trace the selected encoding via mutter().
551
425
    """
552
 
    from .trace import mutter
 
426
    from bzrlib.trace import mutter
553
427
    output_encoding = getattr(sys.stdout, 'encoding', None)
554
428
    if not output_encoding:
555
429
        input_encoding = getattr(sys.stdin, 'encoding', None)
556
430
        if not input_encoding:
557
431
            output_encoding = get_user_encoding()
558
 
            if trace:
559
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
432
            mutter('encoding stdout as osutils.get_user_encoding() %r',
560
433
                   output_encoding)
561
434
        else:
562
435
            output_encoding = input_encoding
563
 
            if trace:
564
 
                mutter('encoding stdout as sys.stdin encoding %r',
565
 
                    output_encoding)
 
436
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
566
437
    else:
567
 
        if trace:
568
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
438
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
569
439
    if output_encoding == 'cp0':
570
440
        # invalid encoding (cp0 means 'no codepage' on Windows)
571
441
        output_encoding = get_user_encoding()
572
 
        if trace:
573
 
            mutter('cp0 is invalid encoding.'
 
442
        mutter('cp0 is invalid encoding.'
574
443
               ' encoding stdout as osutils.get_user_encoding() %r',
575
444
               output_encoding)
576
445
    # check encoding
577
446
    try:
578
447
        codecs.lookup(output_encoding)
579
448
    except LookupError:
580
 
        sys.stderr.write('brz: warning:'
 
449
        sys.stderr.write('bzr: warning:'
581
450
                         ' unknown terminal encoding %s.\n'
582
451
                         '  Using encoding %s instead.\n'
583
452
                         % (output_encoding, get_user_encoding())
592
461
        F = realpath
593
462
    else:
594
463
        F = abspath
595
 
    [p, e] = os.path.split(f)
 
464
    [p,e] = os.path.split(f)
596
465
    if e == "" or e == "." or e == "..":
597
466
        return F(f)
598
467
    else:
602
471
def isdir(f):
603
472
    """True if f is an accessible directory."""
604
473
    try:
605
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
474
        return S_ISDIR(os.lstat(f)[ST_MODE])
606
475
    except OSError:
607
476
        return False
608
477
 
610
479
def isfile(f):
611
480
    """True if f is a regular file."""
612
481
    try:
613
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
482
        return S_ISREG(os.lstat(f)[ST_MODE])
614
483
    except OSError:
615
484
        return False
616
485
 
617
486
def islink(f):
618
487
    """True if f is a symlink."""
619
488
    try:
620
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
489
        return S_ISLNK(os.lstat(f)[ST_MODE])
621
490
    except OSError:
622
491
        return False
623
492
 
639
508
    if dir == '':
640
509
        return True
641
510
 
642
 
    if not dir.endswith('/'):
 
511
    if dir[-1] != '/':
643
512
        dir += '/'
644
513
 
645
514
    return fname.startswith(dir)
720
589
    # drives).
721
590
    if not segment_size:
722
591
        segment_size = 5242880 # 5MB
723
 
    offsets = range(0, len(bytes), segment_size)
724
 
    view = memoryview(bytes)
 
592
    segments = range(len(bytes) / segment_size + 1)
725
593
    write = file_handle.write
726
 
    for offset in offsets:
727
 
        write(view[offset:offset+segment_size])
 
594
    for segment_index in segments:
 
595
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
596
        write(segment)
728
597
 
729
598
 
730
599
def file_iterator(input_file, readsize=32768):
735
604
        yield b
736
605
 
737
606
 
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
607
def sha_file(f):
749
608
    """Calculate the hexdigest of an open file.
750
609
 
757
616
        if not b:
758
617
            break
759
618
        s.update(b)
760
 
    return _hexdigest(s)
 
619
    return s.hexdigest()
761
620
 
762
621
 
763
622
def size_sha_file(f):
775
634
            break
776
635
        size += len(b)
777
636
        s.update(b)
778
 
    return size, _hexdigest(s)
 
637
    return size, s.hexdigest()
779
638
 
780
639
 
781
640
def sha_file_by_name(fname):
782
641
    """Calculate the SHA1 of a file by reading the full text"""
783
642
    s = sha()
784
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
643
    f = os.open(fname, os.O_RDONLY | O_BINARY)
785
644
    try:
786
645
        while True:
787
646
            b = os.read(f, 1<<16)
788
647
            if not b:
789
 
                return _hexdigest(s)
 
648
                return s.hexdigest()
790
649
            s.update(b)
791
650
    finally:
792
651
        os.close(f)
795
654
def sha_strings(strings, _factory=sha):
796
655
    """Return the sha-1 of concatenation of strings"""
797
656
    s = _factory()
798
 
    for string in strings:
799
 
        s.update(string)
800
 
    return _hexdigest(s)
 
657
    map(s.update, strings)
 
658
    return s.hexdigest()
801
659
 
802
660
 
803
661
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))
 
662
    return _factory(f).hexdigest()
806
663
 
807
664
 
808
665
def fingerprint_file(f):
809
666
    b = f.read()
810
667
    return {'size': len(b),
811
 
            'sha1': _hexdigest(sha(b))}
 
668
            'sha1': sha(b).hexdigest()}
812
669
 
813
670
 
814
671
def compare_files(a, b):
819
676
        bi = b.read(BUFSIZE)
820
677
        if ai != bi:
821
678
            return False
822
 
        if not ai:
 
679
        if ai == '':
823
680
            return True
824
681
 
825
682
 
831
688
    return offset.days * 86400 + offset.seconds
832
689
 
833
690
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
834
 
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
835
 
 
836
691
 
837
692
def format_date(t, offset=0, timezone='original', date_fmt=None,
838
693
                show_offset=True):
852
707
    date_str = time.strftime(date_fmt, tt)
853
708
    return date_str + offset_str
854
709
 
855
 
 
856
 
# Cache of formatted offset strings
857
 
_offset_cache = {}
858
 
 
859
 
 
860
 
def format_date_with_offset_in_original_timezone(t, offset=0,
861
 
    _cache=_offset_cache):
862
 
    """Return a formatted date string in the original timezone.
863
 
 
864
 
    This routine may be faster then format_date.
865
 
 
866
 
    :param t: Seconds since the epoch.
867
 
    :param offset: Timezone offset in seconds east of utc.
868
 
    """
869
 
    if offset is None:
870
 
        offset = 0
871
 
    tt = time.gmtime(t + offset)
872
 
    date_fmt = _default_format_by_weekday_num[tt[6]]
873
 
    date_str = time.strftime(date_fmt, tt)
874
 
    offset_str = _cache.get(offset, None)
875
 
    if offset_str is None:
876
 
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
877
 
        _cache[offset] = offset_str
878
 
    return date_str + offset_str
879
 
 
880
 
 
881
710
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
882
711
                      show_offset=True):
883
712
    """Return an unicode date string formatted according to the current locale.
893
722
    (date_fmt, tt, offset_str) = \
894
723
               _format_date(t, offset, timezone, date_fmt, show_offset)
895
724
    date_str = time.strftime(date_fmt, tt)
896
 
    if not isinstance(date_str, text_type):
 
725
    if not isinstance(date_str, unicode):
897
726
        date_str = date_str.decode(get_user_encoding(), 'replace')
898
727
    return date_str + offset_str
899
728
 
900
 
 
901
729
def _format_date(t, offset, timezone, date_fmt, show_offset):
902
730
    if timezone == 'utc':
903
731
        tt = time.gmtime(t)
910
738
        tt = time.localtime(t)
911
739
        offset = local_time_offset(t)
912
740
    else:
913
 
        raise UnsupportedTimezoneFormat(timezone)
 
741
        raise errors.UnsupportedTimezoneFormat(timezone)
914
742
    if date_fmt is None:
915
743
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
916
744
    if show_offset:
975
803
 
976
804
def filesize(f):
977
805
    """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":
 
806
    return os.fstat(f.fileno())[ST_SIZE]
 
807
 
 
808
 
 
809
# Define rand_bytes based on platform.
 
810
try:
 
811
    # Python 2.4 and later have os.urandom,
 
812
    # but it doesn't work on some arches
 
813
    os.urandom(1)
 
814
    rand_bytes = os.urandom
 
815
except (NotImplementedError, AttributeError):
 
816
    # If python doesn't have os.urandom, or it doesn't work,
 
817
    # then try to first pull random data from /dev/urandom
988
818
    try:
989
 
        rand_bytes(1)
990
 
    except NotImplementedError:
 
819
        rand_bytes = file('/dev/urandom', 'rb').read
 
820
    # Otherwise, use this hack as a last resort
 
821
    except (IOError, OSError):
991
822
        # not well seeded, but better than nothing
992
823
        def rand_bytes(n):
993
824
            import random
1007
838
    """
1008
839
    s = ''
1009
840
    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]
 
841
        s += ALNUM[ord(raw_byte) % 36]
1014
842
    return s
1015
843
 
1016
844
 
1026
854
    rps = []
1027
855
    for f in ps:
1028
856
        if f == '..':
1029
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
857
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1030
858
        elif (f == '.') or (f == ''):
1031
859
            pass
1032
860
        else:
1037
865
def joinpath(p):
1038
866
    for f in p:
1039
867
        if (f == '..') or (f is None) or (f == ''):
1040
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
868
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1041
869
    return pathjoin(*p)
1042
870
 
1043
871
 
1044
872
def parent_directories(filename):
1045
873
    """Return the list of parent directories, deepest first.
1046
 
 
 
874
    
1047
875
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1048
876
    """
1049
877
    parents = []
1065
893
    implementation should be loaded instead::
1066
894
 
1067
895
    >>> try:
1068
 
    >>>     import breezy._fictional_extension_pyx
 
896
    >>>     import bzrlib._fictional_extension_pyx
1069
897
    >>> except ImportError, e:
1070
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1071
 
    >>>     import breezy._fictional_extension_py
 
898
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
899
    >>>     import bzrlib._fictional_extension_py
1072
900
    """
1073
901
    # NB: This docstring is just an example, not a doctest, because doctest
1074
902
    # currently can't cope with the use of lazy imports in this namespace --
1075
903
    # mbp 20090729
1076
 
 
 
904
    
1077
905
    # This currently doesn't report the failure at the time it occurs, because
1078
906
    # they tend to happen very early in startup when we can't check config
1079
907
    # files etc, and also we want to report all failures but not spam the user
1080
908
    # with 10 warnings.
 
909
    from bzrlib import trace
1081
910
    exception_str = str(exception)
1082
911
    if exception_str not in _extension_load_failures:
1083
912
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1087
916
def report_extension_load_failures():
1088
917
    if not _extension_load_failures:
1089
918
        return
1090
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
919
    from bzrlib.config import GlobalConfig
 
920
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1091
921
        return
1092
922
    # the warnings framework should by default show this only once
1093
 
    from .trace import warning
 
923
    from bzrlib.trace import warning
1094
924
    warning(
1095
 
        "brz: warning: some compiled extensions could not be loaded; "
1096
 
        "see ``brz help missing-extensions``")
 
925
        "bzr: warning: some compiled extensions could not be loaded; "
 
926
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1097
927
    # we no longer show the specific missing extensions here, because it makes
1098
928
    # the message too long and scary - see
1099
929
    # https://bugs.launchpad.net/bzr/+bug/430529
1100
930
 
1101
931
 
1102
932
try:
1103
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1104
 
except ImportError as e:
 
933
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
934
except ImportError, e:
1105
935
    failed_to_load_extension(e)
1106
 
    from ._chunks_to_lines_py import chunks_to_lines
 
936
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1107
937
 
1108
938
 
1109
939
def split_lines(s):
1122
952
 
1123
953
    This supports Unicode or plain string objects.
1124
954
    """
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]]
 
955
    lines = s.split('\n')
 
956
    result = [line + '\n' for line in lines[:-1]]
1128
957
    if lines[-1]:
1129
958
        result.append(lines[-1])
1130
959
    return result
1141
970
        return
1142
971
    try:
1143
972
        os.link(src, dest)
1144
 
    except (OSError, IOError) as e:
 
973
    except (OSError, IOError), e:
1145
974
        if e.errno != errno.EXDEV:
1146
975
            raise
1147
976
        shutil.copyfile(src, dest)
1148
977
 
1149
978
 
1150
979
def delete_any(path):
1151
 
    """Delete a file, symlink or directory.
1152
 
 
 
980
    """Delete a file, symlink or directory.  
 
981
    
1153
982
    Will delete even if readonly.
1154
983
    """
1155
984
    try:
1156
985
       _delete_file_or_dir(path)
1157
 
    except (OSError, IOError) as e:
 
986
    except (OSError, IOError), e:
1158
987
        if e.errno in (errno.EPERM, errno.EACCES):
1159
988
            # make writable and try again
1160
989
            try:
1220
1049
    #    separators
1221
1050
    # 3) '\xa0' isn't unicode safe since it is >128.
1222
1051
 
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:
 
1052
    # This should *not* be a unicode set of characters in case the source
 
1053
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1054
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1055
    # is utf-8
 
1056
    for ch in ' \t\n\r\v\f':
1228
1057
        if ch in s:
1229
1058
            return True
1230
1059
    else:
1241
1070
 
1242
1071
 
1243
1072
def relpath(base, path):
1244
 
    """Return path relative to base, or raise PathNotChild exception.
 
1073
    """Return path relative to base, or raise exception.
1245
1074
 
1246
1075
    The path may be either an absolute path or a path relative to the
1247
1076
    current working directory.
1249
1078
    os.path.commonprefix (python2.4) has a bad bug that it works just
1250
1079
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1251
1080
    avoids that problem.
1252
 
 
1253
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1254
 
    PathNotChild exceptions regardless of `path`.
1255
1081
    """
1256
1082
 
1257
1083
    if len(base) < MIN_ABS_PATHLENGTH:
1258
1084
        # must have space for e.g. a drive letter
1259
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1085
        raise ValueError('%r is too short to calculate a relative path'
1260
1086
            % (base,))
1261
1087
 
1262
1088
    rp = abspath(path)
1344
1170
    # but for now, we haven't optimized...
1345
1171
    return [canonical_relpath(base, p) for p in paths]
1346
1172
 
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
1173
def safe_unicode(unicode_or_utf8_string):
1364
1174
    """Coerce unicode_or_utf8_string into unicode.
1365
1175
 
1367
1177
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1368
1178
    wrapped in a BzrBadParameterNotUnicode exception.
1369
1179
    """
1370
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1180
    if isinstance(unicode_or_utf8_string, unicode):
1371
1181
        return unicode_or_utf8_string
1372
1182
    try:
1373
1183
        return unicode_or_utf8_string.decode('utf8')
1381
1191
    If it is a str, it is returned.
1382
1192
    If it is Unicode, it is encoded into a utf-8 string.
1383
1193
    """
1384
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1194
    if isinstance(unicode_or_utf8_string, str):
1385
1195
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1386
1196
        #       performance if we are dealing with lots of apis that want a
1387
1197
        #       utf-8 revision id
1394
1204
    return unicode_or_utf8_string.encode('utf-8')
1395
1205
 
1396
1206
 
1397
 
def safe_revision_id(unicode_or_utf8_string):
 
1207
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1208
                        ' Revision id generators should be creating utf8'
 
1209
                        ' revision ids.')
 
1210
 
 
1211
 
 
1212
def safe_revision_id(unicode_or_utf8_string, warn=True):
1398
1213
    """Revision ids should now be utf8, but at one point they were unicode.
1399
1214
 
1400
1215
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1401
1216
        utf8 or None).
 
1217
    :param warn: Functions that are sanitizing user data can set warn=False
1402
1218
    :return: None or a utf8 revision id.
1403
1219
    """
1404
1220
    if (unicode_or_utf8_string is None
1405
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1221
        or unicode_or_utf8_string.__class__ == str):
1406
1222
        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):
 
1223
    if warn:
 
1224
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1225
                               stacklevel=2)
 
1226
    return cache_utf8.encode(unicode_or_utf8_string)
 
1227
 
 
1228
 
 
1229
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1230
                    ' generators should be creating utf8 file ids.')
 
1231
 
 
1232
 
 
1233
def safe_file_id(unicode_or_utf8_string, warn=True):
1413
1234
    """File ids should now be utf8, but at one point they were unicode.
1414
1235
 
1415
1236
    This is the same as safe_utf8, except it uses the cached encode functions
1417
1238
 
1418
1239
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1419
1240
        utf8 or None).
 
1241
    :param warn: Functions that are sanitizing user data can set warn=False
1420
1242
    :return: None or a utf8 file id.
1421
1243
    """
1422
1244
    if (unicode_or_utf8_string is None
1423
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1245
        or unicode_or_utf8_string.__class__ == str):
1424
1246
        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.')
 
1247
    if warn:
 
1248
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1249
                               stacklevel=2)
 
1250
    return cache_utf8.encode(unicode_or_utf8_string)
1427
1251
 
1428
1252
 
1429
1253
_platform_normalizes_filenames = False
1434
1258
def normalizes_filenames():
1435
1259
    """Return True if this platform normalizes unicode filenames.
1436
1260
 
1437
 
    Only Mac OSX.
 
1261
    Mac OSX does, Windows/Linux do not.
1438
1262
    """
1439
1263
    return _platform_normalizes_filenames
1440
1264
 
1445
1269
    On platforms where the system normalizes filenames (Mac OSX),
1446
1270
    you can access a file by any path which will normalize correctly.
1447
1271
    On platforms where the system does not normalize filenames
1448
 
    (everything else), you have to access a file by its exact path.
 
1272
    (Windows, Linux), you have to access a file by its exact path.
1449
1273
 
1450
1274
    Internally, bzr only supports NFC normalization, since that is
1451
1275
    the standard for XML documents.
1454
1278
    can be accessed by that path.
1455
1279
    """
1456
1280
 
1457
 
    if isinstance(path, bytes):
1458
 
        path = path.decode(sys.getfilesystemencoding())
1459
 
    return unicodedata.normalize('NFC', path), True
 
1281
    return unicodedata.normalize('NFC', unicode(path)), True
1460
1282
 
1461
1283
 
1462
1284
def _inaccessible_normalized_filename(path):
1463
1285
    __doc__ = _accessible_normalized_filename.__doc__
1464
1286
 
1465
 
    if isinstance(path, bytes):
1466
 
        path = path.decode(sys.getfilesystemencoding())
1467
 
    normalized = unicodedata.normalize('NFC', path)
 
1287
    normalized = unicodedata.normalize('NFC', unicode(path))
1468
1288
    return normalized, normalized == path
1469
1289
 
1470
1290
 
1474
1294
    normalized_filename = _inaccessible_normalized_filename
1475
1295
 
1476
1296
 
1477
 
def set_signal_handler(signum, handler, restart_syscall=True):
1478
 
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
1479
 
    on platforms that support that.
1480
 
 
1481
 
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
1482
 
        automatically restart (by calling `signal.siginterrupt(signum,
1483
 
        False)`).  May be ignored if the feature is not available on this
1484
 
        platform or Python version.
1485
 
    """
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
1497
 
    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.
1502
 
            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
 
    return old_handler
1511
 
 
1512
 
 
1513
 
default_terminal_width = 80
1514
 
"""The default terminal width for ttys.
1515
 
 
1516
 
This is defined so that higher levels can share a common fallback value when
1517
 
terminal_width() returns None.
1518
 
"""
1519
 
 
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
 
 
1527
1297
def terminal_width():
1528
 
    """Return terminal width.
1529
 
 
1530
 
    None is returned if the width can't established precisely.
1531
 
 
1532
 
    The rules are:
1533
 
    - if BRZ_COLUMNS is set, returns its value
1534
 
    - 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
 
    - if COLUMNS is set, returns its value,
1538
 
    - if the OS has a value (even though it's never changed), return its value.
1539
 
 
1540
 
    From there, we need to query the OS to get the size of the controlling
1541
 
    terminal.
1542
 
 
1543
 
    On Unices we query the OS by:
1544
 
    - get termios.TIOCGWINSZ
1545
 
    - if an error occurs or a negative value is obtained, returns None
1546
 
 
1547
 
    On Windows we query the OS by:
1548
 
    - win32utils.get_console_size() decides,
1549
 
    - returns None on error (provided default value)
1550
 
    """
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
 
 
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
1566
 
    try:
1567
 
        width = int(os.environ['BRZ_COLUMNS'])
1568
 
    except (KeyError, ValueError):
1569
 
        width = None
1570
 
    if width is not None:
1571
 
        if width > 0:
1572
 
            return width
1573
 
        else:
1574
 
            return None
1575
 
 
1576
 
    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.
1579
 
        return None
1580
 
 
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.
1598
 
    try:
1599
 
        return int(os.environ['COLUMNS'])
1600
 
    except (KeyError, ValueError):
1601
 
        pass
1602
 
 
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
1607
 
 
1608
 
    # The width could not be determined.
1609
 
    return None
1610
 
 
1611
 
 
1612
 
def _win32_terminal_size(width, height):
1613
 
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1614
 
    return width, height
1615
 
 
1616
 
 
1617
 
def _ioctl_terminal_size(width, height):
 
1298
    """Return estimated terminal width."""
 
1299
    if sys.platform == 'win32':
 
1300
        return win32utils.get_console_size()[0]
 
1301
    width = 0
1618
1302
    try:
1619
1303
        import struct, fcntl, termios
1620
1304
        s = struct.pack('HHHH', 0, 0, 0, 0)
1621
1305
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1622
 
        height, width = struct.unpack('HHHH', x)[0:2]
1623
 
    except (IOError, AttributeError):
 
1306
        width = struct.unpack('HHHH', x)[1]
 
1307
    except IOError:
1624
1308
        pass
1625
 
    return width, height
1626
 
 
1627
 
_terminal_size = None
1628
 
"""Returns the terminal size as (width, height).
1629
 
 
1630
 
:param width: Default value for width.
1631
 
:param height: Default value for height.
1632
 
 
1633
 
This is defined specifically for each OS and query the size of the controlling
1634
 
terminal. If any error occurs, the provided default values should be returned.
1635
 
"""
1636
 
if sys.platform == 'win32':
1637
 
    _terminal_size = _win32_terminal_size
1638
 
else:
1639
 
    _terminal_size = _ioctl_terminal_size
 
1309
    if width <= 0:
 
1310
        try:
 
1311
            width = int(os.environ['COLUMNS'])
 
1312
        except:
 
1313
            pass
 
1314
    if width <= 0:
 
1315
        width = 80
 
1316
 
 
1317
    return width
1640
1318
 
1641
1319
 
1642
1320
def supports_executable():
1669
1347
        if orig_val is not None:
1670
1348
            del os.environ[env_variable]
1671
1349
    else:
1672
 
        if not PY3 and isinstance(value, text_type):
 
1350
        if isinstance(value, unicode):
1673
1351
            value = value.encode(get_user_encoding())
1674
1352
        os.environ[env_variable] = value
1675
1353
    return orig_val
1767
1445
        dirblock = []
1768
1446
        append = dirblock.append
1769
1447
        try:
1770
 
            names = sorted(map(decode_filename, _listdir(top)))
1771
 
        except OSError as e:
 
1448
            names = sorted(_listdir(top))
 
1449
        except OSError, e:
1772
1450
            if not _is_error_enotdir(e):
1773
1451
                raise
1774
1452
        else:
1827
1505
    """
1828
1506
    global _selected_dir_reader
1829
1507
    if _selected_dir_reader is None:
1830
 
        if sys.platform == "win32":
 
1508
        fs_encoding = _fs_enc.upper()
 
1509
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1510
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1511
            # TODO: We possibly could support Win98 by falling back to the
 
1512
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1513
            #       but that gets a bit tricky, and requires custom compiling
 
1514
            #       for win98 anyway.
1831
1515
            try:
1832
 
                from ._walkdirs_win32 import Win32ReadDir
 
1516
                from bzrlib._walkdirs_win32 import Win32ReadDir
1833
1517
                _selected_dir_reader = Win32ReadDir()
1834
1518
            except ImportError:
1835
1519
                pass
1836
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1520
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1521
            # ANSI_X3.4-1968 is a form of ASCII
1837
1522
            try:
1838
 
                from ._readdir_pyx import UTF8DirReader
 
1523
                from bzrlib._readdir_pyx import UTF8DirReader
1839
1524
                _selected_dir_reader = UTF8DirReader()
1840
 
            except ImportError as e:
 
1525
            except ImportError, e:
1841
1526
                failed_to_load_extension(e)
1842
1527
                pass
1843
1528
 
1893
1578
        _kind_from_mode = file_kind_from_stat_mode
1894
1579
 
1895
1580
        if prefix:
1896
 
            relprefix = prefix + b'/'
 
1581
            relprefix = prefix + '/'
1897
1582
        else:
1898
 
            relprefix = b''
1899
 
        top_slash = top + '/'
 
1583
            relprefix = ''
 
1584
        top_slash = top + u'/'
1900
1585
 
1901
1586
        dirblock = []
1902
1587
        append = dirblock.append
1941
1626
        link_to = os.readlink(source)
1942
1627
        os.symlink(link_to, dest)
1943
1628
 
1944
 
    real_handlers = {'file': shutil.copy2,
1945
 
                     'symlink': copy_link,
1946
 
                     'directory': copy_dir,
 
1629
    real_handlers = {'file':shutil.copy2,
 
1630
                     'symlink':copy_link,
 
1631
                     'directory':copy_dir,
1947
1632
                    }
1948
1633
    real_handlers.update(handlers)
1949
1634
 
1955
1640
            real_handlers[kind](abspath, relpath)
1956
1641
 
1957
1642
 
1958
 
def copy_ownership_from_path(dst, src=None):
1959
 
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1960
 
 
1961
 
    If src is None, the containing directory is used as source. If chown
1962
 
    fails, the error is ignored and a warning is printed.
1963
 
    """
1964
 
    chown = getattr(os, 'chown', None)
1965
 
    if chown is None:
1966
 
        return
1967
 
 
1968
 
    if src == None:
1969
 
        src = os.path.dirname(dst)
1970
 
        if src == '':
1971
 
            src = '.'
1972
 
 
1973
 
    try:
1974
 
        s = os.stat(src)
1975
 
        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()
1981
 
 
1982
 
 
1983
1643
def path_prefix_key(path):
1984
1644
    """Generate a prefix-order path key for path.
1985
1645
 
1986
1646
    This can be used to sort paths in the same way that walkdirs does.
1987
1647
    """
1988
 
    return (dirname(path), path)
 
1648
    return (dirname(path) , path)
1989
1649
 
1990
1650
 
1991
1651
def compare_paths_prefix_order(path_a, path_b):
1998
1658
_cached_user_encoding = None
1999
1659
 
2000
1660
 
2001
 
def get_user_encoding():
 
1661
def get_user_encoding(use_cache=True):
2002
1662
    """Find out what the preferred user encoding is.
2003
1663
 
2004
1664
    This is generally the encoding that is used for command line parameters
2005
1665
    and file contents. This may be different from the terminal encoding
2006
1666
    or the filesystem encoding.
2007
1667
 
 
1668
    :param  use_cache:  Enable cache for detected encoding.
 
1669
                        (This parameter is turned on by default,
 
1670
                        and required only for selftesting)
 
1671
 
2008
1672
    :return: A string defining the preferred user encoding
2009
1673
    """
2010
1674
    global _cached_user_encoding
2011
 
    if _cached_user_encoding is not None:
 
1675
    if _cached_user_encoding is not None and use_cache:
2012
1676
        return _cached_user_encoding
2013
1677
 
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)
 
1678
    if sys.platform == 'darwin':
 
1679
        # python locale.getpreferredencoding() always return
 
1680
        # 'mac-roman' on darwin. That's a lie.
 
1681
        sys.platform = 'posix'
 
1682
        try:
 
1683
            if os.environ.get('LANG', None) is None:
 
1684
                # If LANG is not set, we end up with 'ascii', which is bad
 
1685
                # ('mac-roman' is more than ascii), so we set a default which
 
1686
                # will give us UTF-8 (which appears to work in all cases on
 
1687
                # OSX). Users are still free to override LANG of course, as
 
1688
                # long as it give us something meaningful. This work-around
 
1689
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1690
                # work with them too -- vila 20080908
 
1691
                os.environ['LANG'] = 'en_US.UTF-8'
 
1692
            import locale
 
1693
        finally:
 
1694
            sys.platform = 'darwin'
2020
1695
    else:
2021
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2022
 
        user_encoding = locale.getpreferredencoding(False)
 
1696
        import locale
2023
1697
 
2024
1698
    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:'
 
1699
        user_encoding = locale.getpreferredencoding()
 
1700
    except locale.Error, e:
 
1701
        sys.stderr.write('bzr: warning: %s\n'
 
1702
                         '  Could not determine what text encoding to use.\n'
 
1703
                         '  This error usually means your Python interpreter\n'
 
1704
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1705
                         "  Continuing with ascii encoding.\n"
 
1706
                         % (e, os.environ.get('LANG')))
 
1707
        user_encoding = 'ascii'
 
1708
 
 
1709
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1710
    # treat that as ASCII, and not support printing unicode characters to the
 
1711
    # console.
 
1712
    #
 
1713
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1714
    if user_encoding in (None, 'cp0', ''):
 
1715
        user_encoding = 'ascii'
 
1716
    else:
 
1717
        # check encoding
 
1718
        try:
 
1719
            codecs.lookup(user_encoding)
 
1720
        except LookupError:
 
1721
            sys.stderr.write('bzr: warning:'
2029
1722
                             ' unknown encoding %s.'
2030
1723
                             ' Continuing with ascii encoding.\n'
2031
1724
                             % user_encoding
2032
1725
                            )
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
 
1726
            user_encoding = 'ascii'
 
1727
 
 
1728
    if use_cache:
 
1729
        _cached_user_encoding = user_encoding
 
1730
 
2045
1731
    return user_encoding
2046
1732
 
2047
1733
 
2048
 
def get_diff_header_encoding():
2049
 
    return get_terminal_encoding()
2050
 
 
2051
 
 
2052
1734
def get_host_name():
2053
1735
    """Return the current unicode host name.
2054
1736
 
2056
1738
    behaves inconsistently on different platforms.
2057
1739
    """
2058
1740
    if sys.platform == "win32":
 
1741
        import win32utils
2059
1742
        return win32utils.get_host_name()
2060
1743
    else:
2061
1744
        import socket
2062
 
        if PY3:
2063
 
            return socket.gethostname()
2064
1745
        return socket.gethostname().decode(get_user_encoding())
2065
1746
 
2066
1747
 
2067
 
# We must not read/write any more than 64k at a time from/to a socket so we
2068
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
2069
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2070
 
# data at once.
2071
 
MAX_SOCKET_CHUNK = 64 * 1024
2072
 
 
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
 
def read_bytes_from_socket(sock, report_activity=None,
2082
 
        max_read_size=MAX_SOCKET_CHUNK):
2083
 
    """Read up to max_read_size of bytes from sock and notify of progress.
2084
 
 
2085
 
    Translates "Connection reset by peer" into file-like EOF (return an
2086
 
    empty string rather than raise an error), and repeats the recv if
2087
 
    interrupted by a signal.
2088
 
    """
2089
 
    while True:
2090
 
        try:
2091
 
            data = sock.recv(max_read_size)
2092
 
        except socket.error as e:
2093
 
            eno = e.args[0]
2094
 
            if eno in _end_of_stream_errors:
2095
 
                # The connection was closed by the other side.  Callers expect
2096
 
                # an empty string to signal end-of-stream.
2097
 
                return b""
2098
 
            elif eno == errno.EINTR:
2099
 
                # Retry the interrupted recv.
2100
 
                continue
2101
 
            raise
2102
 
        else:
2103
 
            if report_activity is not None:
2104
 
                report_activity(len(data), 'read')
2105
 
            return data
2106
 
 
2107
 
 
2108
 
def recv_all(socket, count):
 
1748
def recv_all(socket, bytes):
2109
1749
    """Receive an exact number of bytes.
2110
1750
 
2111
1751
    Regular Socket.recv() may return less than the requested number of bytes,
2112
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1752
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2113
1753
    on all platforms, but this should work everywhere.  This will return
2114
1754
    less than the requested amount if the remote end closes.
2115
1755
 
2116
1756
    This isn't optimized and is intended mostly for use in testing.
2117
1757
    """
2118
 
    b = b''
2119
 
    while len(b) < count:
2120
 
        new = read_bytes_from_socket(socket, None, count - len(b))
2121
 
        if new == b'':
 
1758
    b = ''
 
1759
    while len(b) < bytes:
 
1760
        new = until_no_eintr(socket.recv, bytes - len(b))
 
1761
        if new == '':
2122
1762
            break # eof
2123
1763
        b += new
2124
1764
    return b
2125
1765
 
2126
1766
 
2127
 
def send_all(sock, bytes, report_activity=None):
 
1767
def send_all(socket, bytes, report_activity=None):
2128
1768
    """Send all bytes on a socket.
2129
1769
 
2130
 
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2131
 
    some platforms, and catches EINTR which may be thrown if the send is
2132
 
    interrupted by a signal.
2133
 
 
2134
 
    This is preferred to socket.sendall(), because it avoids portability bugs
2135
 
    and provides activity reporting.
 
1770
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1771
    implementation sends no more than 64k at a time, which avoids this problem.
2136
1772
 
2137
1773
    :param report_activity: Call this as bytes are read, see
2138
1774
        Transport._report_activity
2139
1775
    """
2140
 
    sent_total = 0
2141
 
    byte_count = len(bytes)
2142
 
    view = memoryview(bytes)
2143
 
    while sent_total < byte_count:
2144
 
        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)
2150
 
            if e.args[0] != errno.EINTR:
2151
 
                raise
2152
 
        else:
2153
 
            if sent == 0:
2154
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2155
 
                                             % (sock,))
2156
 
            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
 
1776
    chunk_size = 2**16
 
1777
    for pos in xrange(0, len(bytes), chunk_size):
 
1778
        block = bytes[pos:pos+chunk_size]
 
1779
        if report_activity is not None:
 
1780
            report_activity(len(block), 'write')
 
1781
        until_no_eintr(socket.sendall, block)
2183
1782
 
2184
1783
 
2185
1784
def dereference_path(path):
2204
1803
def resource_string(package, resource_name):
2205
1804
    """Load a resource from a package and return it as a string.
2206
1805
 
2207
 
    Note: Only packages that start with breezy are currently supported.
 
1806
    Note: Only packages that start with bzrlib are currently supported.
2208
1807
 
2209
1808
    This is designed to be a lightweight implementation of resource
2210
1809
    loading in a way which is API compatible with the same API from
2213
1812
    If and when pkg_resources becomes a standard library, this routine
2214
1813
    can delegate to it.
2215
1814
    """
2216
 
    # Check package name is within breezy
2217
 
    if package == "breezy":
 
1815
    # Check package name is within bzrlib
 
1816
    if package == "bzrlib":
2218
1817
        resource_relpath = resource_name
2219
 
    elif package.startswith("breezy."):
2220
 
        package = package[len("breezy."):].replace('.', os.sep)
 
1818
    elif package.startswith("bzrlib."):
 
1819
        package = package[len("bzrlib."):].replace('.', os.sep)
2221
1820
        resource_relpath = pathjoin(package, resource_name)
2222
1821
    else:
2223
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
1822
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2224
1823
 
2225
1824
    # Map the resource to a file and read its contents
2226
 
    base = dirname(breezy.__file__)
 
1825
    base = dirname(bzrlib.__file__)
2227
1826
    if getattr(sys, 'frozen', None):    # bzr.exe
2228
1827
        base = abspath(pathjoin(base, '..', '..'))
2229
 
    with open(pathjoin(base, resource_relpath), "rU") as f:
2230
 
        return f.read()
 
1828
    filename = pathjoin(base, resource_relpath)
 
1829
    return open(filename, 'rU').read()
 
1830
 
2231
1831
 
2232
1832
def file_kind_from_stat_mode_thunk(mode):
2233
1833
    global file_kind_from_stat_mode
2234
1834
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2235
1835
        try:
2236
 
            from ._readdir_pyx import UTF8DirReader
 
1836
            from bzrlib._readdir_pyx import UTF8DirReader
2237
1837
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2238
 
        except ImportError as e:
 
1838
        except ImportError, e:
2239
1839
            # This is one time where we won't warn that an extension failed to
2240
1840
            # load. The extension is never available on Windows anyway.
2241
 
            from ._readdir_py import (
 
1841
            from bzrlib._readdir_py import (
2242
1842
                _kind_from_mode as file_kind_from_stat_mode
2243
1843
                )
2244
1844
    return file_kind_from_stat_mode(mode)
2245
1845
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2246
1846
 
2247
 
def file_stat(f, _lstat=os.lstat):
 
1847
 
 
1848
def file_kind(f, _lstat=os.lstat):
2248
1849
    try:
2249
 
        # XXX cache?
2250
 
        return _lstat(f)
2251
 
    except OSError as e:
 
1850
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
1851
    except OSError, e:
2252
1852
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2253
1853
            raise errors.NoSuchFile(f)
2254
1854
        raise
2255
1855
 
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
1856
 
2260
1857
def until_no_eintr(f, *a, **kw):
2261
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2262
 
 
2263
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2264
 
    if EINTR does occur.  This is typically only true for low-level operations
2265
 
    like os.read.  If in any doubt, don't use this.
2266
 
 
2267
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2268
 
    probably code in the Python standard library and other dependencies that
2269
 
    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
2271
 
    directly controls, but it is not a complete solution.
2272
 
    """
 
1858
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2273
1859
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2274
1860
    while True:
2275
1861
        try:
2276
1862
            return f(*a, **kw)
2277
 
        except (IOError, OSError) as e:
 
1863
        except (IOError, OSError), e:
2278
1864
            if e.errno == errno.EINTR:
2279
1865
                continue
2280
1866
            raise
2281
1867
 
 
1868
def re_compile_checked(re_string, flags=0, where=""):
 
1869
    """Return a compiled re, or raise a sensible error.
 
1870
 
 
1871
    This should only be used when compiling user-supplied REs.
 
1872
 
 
1873
    :param re_string: Text form of regular expression.
 
1874
    :param flags: eg re.IGNORECASE
 
1875
    :param where: Message explaining to the user the context where
 
1876
        it occurred, eg 'log search filter'.
 
1877
    """
 
1878
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
1879
    try:
 
1880
        re_obj = re.compile(re_string, flags)
 
1881
        re_obj.search("")
 
1882
        return re_obj
 
1883
    except re.error, e:
 
1884
        if where:
 
1885
            where = ' in ' + where
 
1886
        # despite the name 'error' is a type
 
1887
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1888
            % (where, re_string, e))
 
1889
 
2282
1890
 
2283
1891
if sys.platform == "win32":
 
1892
    import msvcrt
2284
1893
    def getchar():
2285
 
        import msvcrt
2286
1894
        return msvcrt.getch()
2287
1895
else:
 
1896
    import tty
 
1897
    import termios
2288
1898
    def getchar():
2289
 
        import tty
2290
 
        import termios
2291
1899
        fd = sys.stdin.fileno()
2292
1900
        settings = termios.tcgetattr(fd)
2293
1901
        try:
2297
1905
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2298
1906
        return ch
2299
1907
 
2300
 
if sys.platform.startswith('linux'):
 
1908
 
 
1909
if sys.platform == 'linux2':
2301
1910
    def _local_concurrency():
2302
 
        try:
2303
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2304
 
        except (ValueError, OSError, AttributeError):
2305
 
            return None
 
1911
        concurrency = None
 
1912
        prefix = 'processor'
 
1913
        for line in file('/proc/cpuinfo', 'rb'):
 
1914
            if line.startswith(prefix):
 
1915
                concurrency = int(line[line.find(':')+1:]) + 1
 
1916
        return concurrency
2306
1917
elif sys.platform == 'darwin':
2307
1918
    def _local_concurrency():
2308
1919
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2309
1920
                                stdout=subprocess.PIPE).communicate()[0]
2310
 
elif "bsd" in sys.platform:
 
1921
elif sys.platform[0:7] == 'freebsd':
2311
1922
    def _local_concurrency():
2312
1923
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2313
1924
                                stdout=subprocess.PIPE).communicate()[0]
2334
1945
    anything goes wrong.
2335
1946
    """
2336
1947
    global _cached_local_concurrency
2337
 
 
2338
1948
    if _cached_local_concurrency is not None and use_cache:
2339
1949
        return _cached_local_concurrency
2340
1950
 
2341
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2342
 
    if concurrency is None:
2343
 
        import multiprocessing
2344
 
        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
 
1951
    try:
 
1952
        concurrency = _local_concurrency()
 
1953
    except (OSError, IOError):
 
1954
        concurrency = None
2352
1955
    try:
2353
1956
        concurrency = int(concurrency)
2354
1957
    except (TypeError, ValueError):
2356
1959
    if use_cache:
2357
1960
        _cached_concurrency = concurrency
2358
1961
    return concurrency
2359
 
 
2360
 
 
2361
 
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2362
 
    """A stream writer that doesn't decode str arguments."""
2363
 
 
2364
 
    def __init__(self, encode, stream, errors='strict'):
2365
 
        codecs.StreamWriter.__init__(self, stream, errors)
2366
 
        self.encode = encode
2367
 
 
2368
 
    def write(self, object):
2369
 
        if isinstance(object, str):
2370
 
            self.stream.write(object)
2371
 
        else:
2372
 
            data, _ = self.encode(object, self.errors)
2373
 
            self.stream.write(data)
2374
 
 
2375
 
if sys.platform == 'win32':
2376
 
    def open_file(filename, mode='r', bufsize=-1):
2377
 
        """This function is used to override the ``open`` builtin.
2378
 
 
2379
 
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2380
 
        child processes.  Deleting or renaming a closed file opened with this
2381
 
        function is not blocking child processes.
2382
 
        """
2383
 
        writing = 'w' in mode
2384
 
        appending = 'a' in mode
2385
 
        updating = '+' in mode
2386
 
        binary = 'b' in mode
2387
 
 
2388
 
        flags = O_NOINHERIT
2389
 
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2390
 
        # for flags for each modes.
2391
 
        if binary:
2392
 
            flags |= O_BINARY
2393
 
        else:
2394
 
            flags |= O_TEXT
2395
 
 
2396
 
        if writing:
2397
 
            if updating:
2398
 
                flags |= os.O_RDWR
2399
 
            else:
2400
 
                flags |= os.O_WRONLY
2401
 
            flags |= os.O_CREAT | os.O_TRUNC
2402
 
        elif appending:
2403
 
            if updating:
2404
 
                flags |= os.O_RDWR
2405
 
            else:
2406
 
                flags |= os.O_WRONLY
2407
 
            flags |= os.O_CREAT | os.O_APPEND
2408
 
        else: #reading
2409
 
            if updating:
2410
 
                flags |= os.O_RDWR
2411
 
            else:
2412
 
                flags |= os.O_RDONLY
2413
 
 
2414
 
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2415
 
else:
2416
 
    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