~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-12 15:03:17 UTC
  • mfrom: (6491.2.2 lazy-lp-plugin)
  • Revision ID: pqm@pqm.ubuntu.com-20120312150317-nrt00el7ooyvbk94
(jelmer) Lazily load launchpad plugin commands. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
18
20
import os
19
21
import re
20
22
import stat
21
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
23
import sys
24
24
import time
 
25
import codecs
25
26
 
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
28
 
import codecs
29
29
from datetime import datetime
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
 
                    )
 
30
import getpass
 
31
import locale
 
32
import ntpath
37
33
import posixpath
38
 
import sha
 
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
39
37
import shutil
40
 
from shutil import (
41
 
    rmtree,
42
 
    )
 
38
from shutil import rmtree
 
39
import socket
 
40
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 (
45
 
    mkdtemp,
46
 
    )
 
44
from tempfile import mkdtemp
47
45
import unicodedata
48
46
 
49
47
from bzrlib import (
50
48
    cache_utf8,
 
49
    config,
51
50
    errors,
 
51
    trace,
52
52
    win32utils,
53
53
    )
 
54
from bzrlib.i18n import gettext
54
55
""")
55
56
 
56
 
import bzrlib
57
 
from bzrlib import symbol_versioning
58
57
from bzrlib.symbol_versioning import (
 
58
    DEPRECATED_PARAMETER,
59
59
    deprecated_function,
60
 
    )
61
 
from bzrlib.trace import mutter
62
 
 
 
60
    deprecated_in,
 
61
    deprecated_passed,
 
62
    warn as warn_deprecated,
 
63
    )
 
64
 
 
65
from hashlib import (
 
66
    md5,
 
67
    sha1 as sha,
 
68
    )
 
69
 
 
70
 
 
71
import bzrlib
 
72
from bzrlib import symbol_versioning, _fs_enc
 
73
 
 
74
 
 
75
# Cross platform wall-clock time functionality with decent resolution.
 
76
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
77
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
78
# synchronized with ``time.time()``, this is only meant to be used to find
 
79
# delta times by subtracting from another call to this function.
 
80
timer_func = time.time
 
81
if sys.platform == 'win32':
 
82
    timer_func = time.clock
63
83
 
64
84
# On win32, O_BINARY is used to indicate the file should
65
85
# be opened in binary mode, rather than text mode.
66
86
# On other platforms, O_BINARY doesn't exist, because
67
87
# they always open in binary mode, so it is okay to
68
 
# OR with 0 on those platforms
 
88
# OR with 0 on those platforms.
 
89
# O_NOINHERIT and O_TEXT exists only on win32 too.
69
90
O_BINARY = getattr(os, 'O_BINARY', 0)
70
 
 
71
 
# On posix, use lstat instead of stat so that we can
72
 
# operate on broken symlinks. On Windows revert to stat.
73
 
lstat = getattr(os, 'lstat', os.stat)
 
91
O_TEXT = getattr(os, 'O_TEXT', 0)
 
92
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
 
93
 
 
94
 
 
95
def get_unicode_argv():
 
96
    try:
 
97
        user_encoding = get_user_encoding()
 
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
99
    except UnicodeDecodeError:
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
            "application locale.").format(a, user_encoding))
 
102
 
74
103
 
75
104
def make_readonly(filename):
76
105
    """Make a filename read-only."""
77
 
    mod = lstat(filename).st_mode
 
106
    mod = os.lstat(filename).st_mode
78
107
    if not stat.S_ISLNK(mod):
79
108
        mod = mod & 0777555
80
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
81
110
 
82
111
 
83
112
def make_writable(filename):
84
 
    mod = lstat(filename).st_mode
 
113
    mod = os.lstat(filename).st_mode
85
114
    if not stat.S_ISLNK(mod):
86
115
        mod = mod | 0200
87
 
        os.chmod(filename, mod)
 
116
        chmod_if_possible(filename, mod)
 
117
 
 
118
 
 
119
def chmod_if_possible(filename, mode):
 
120
    # Set file mode if that can be safely done.
 
121
    # Sometimes even on unix the filesystem won't allow it - see
 
122
    # https://bugs.launchpad.net/bzr/+bug/606537
 
123
    try:
 
124
        # It is probably faster to just do the chmod, rather than
 
125
        # doing a stat, and then trying to compare
 
126
        os.chmod(filename, mode)
 
127
    except (IOError, OSError),e:
 
128
        # Permission/access denied seems to commonly happen on smbfs; there's
 
129
        # probably no point warning about it.
 
130
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
131
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
132
            trace.mutter("ignore error on chmod of %r: %r" % (
 
133
                filename, e))
 
134
            return
 
135
        raise
 
136
 
 
137
 
 
138
def minimum_path_selection(paths):
 
139
    """Return the smallset subset of paths which are outside paths.
 
140
 
 
141
    :param paths: A container (and hence not None) of paths.
 
142
    :return: A set of paths sufficient to include everything in paths via
 
143
        is_inside, drawn from the paths parameter.
 
144
    """
 
145
    if len(paths) < 2:
 
146
        return set(paths)
 
147
 
 
148
    def sort_key(path):
 
149
        return path.split('/')
 
150
    sorted_paths = sorted(list(paths), key=sort_key)
 
151
 
 
152
    search_paths = [sorted_paths[0]]
 
153
    for path in sorted_paths[1:]:
 
154
        if not is_inside(search_paths[-1], path):
 
155
            # This path is unique, add it
 
156
            search_paths.append(path)
 
157
 
 
158
    return set(search_paths)
88
159
 
89
160
 
90
161
_QUOTE_RE = None
99
170
    global _QUOTE_RE
100
171
    if _QUOTE_RE is None:
101
172
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
102
 
        
 
173
 
103
174
    if _QUOTE_RE.search(f):
104
175
        return '"' + f + '"'
105
176
    else:
108
179
 
109
180
_directory_kind = 'directory'
110
181
 
111
 
_formats = {
112
 
    stat.S_IFDIR:_directory_kind,
113
 
    stat.S_IFCHR:'chardev',
114
 
    stat.S_IFBLK:'block',
115
 
    stat.S_IFREG:'file',
116
 
    stat.S_IFIFO:'fifo',
117
 
    stat.S_IFLNK:'symlink',
118
 
    stat.S_IFSOCK:'socket',
119
 
}
120
 
 
121
 
 
122
 
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
123
 
    """Generate a file kind from a stat mode. This is used in walkdirs.
124
 
 
125
 
    Its performance is critical: Do not mutate without careful benchmarking.
126
 
    """
127
 
    try:
128
 
        return _formats[stat_mode & 0170000]
129
 
    except KeyError:
130
 
        return _unknown
131
 
 
132
 
 
133
 
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
134
 
    try:
135
 
        return _mapper(_lstat(f).st_mode)
136
 
    except OSError, e:
137
 
        if getattr(e, 'errno', None) == errno.ENOENT:
138
 
            raise errors.NoSuchFile(f)
139
 
        raise
140
 
 
141
 
 
142
182
def get_umask():
143
183
    """Return the current umask"""
144
184
    # Assume that people aren't messing with the umask while running
161
201
    try:
162
202
        return _kind_marker_map[kind]
163
203
    except KeyError:
164
 
        raise errors.BzrError('invalid file kind %r' % kind)
 
204
        # Slightly faster than using .get(, '') when the common case is that
 
205
        # kind will be found
 
206
        return ''
165
207
 
166
208
 
167
209
lexists = getattr(os.path, 'lexists', None)
175
217
            if e.errno == errno.ENOENT:
176
218
                return False;
177
219
            else:
178
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
220
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
179
221
 
180
222
 
181
223
def fancy_rename(old, new, rename_func, unlink_func):
182
224
    """A fancy rename, when you don't have atomic rename.
183
 
    
 
225
 
184
226
    :param old: The old path, to rename from
185
227
    :param new: The new path, to rename to
186
228
    :param rename_func: The potentially non-atomic rename function
187
 
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
229
    :param unlink_func: A way to delete the target file if the full rename
 
230
        succeeds
188
231
    """
189
 
 
190
232
    # sftp rename doesn't allow overwriting, so play tricks:
191
 
    import random
192
233
    base = os.path.basename(new)
193
234
    dirname = os.path.dirname(new)
194
 
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
235
    # callers use different encodings for the paths so the following MUST
 
236
    # respect that. We rely on python upcasting to unicode if new is unicode
 
237
    # and keeping a str if not.
 
238
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
 
239
                                      os.getpid(), rand_chars(10))
195
240
    tmp_name = pathjoin(dirname, tmp_name)
196
241
 
197
242
    # Rename the file out of the way, but keep track if it didn't exist
217
262
    else:
218
263
        file_existed = True
219
264
 
 
265
    failure_exc = None
220
266
    success = False
221
267
    try:
222
 
        # This may throw an exception, in which case success will
223
 
        # not be set.
224
 
        rename_func(old, new)
225
 
        success = True
 
268
        try:
 
269
            # This may throw an exception, in which case success will
 
270
            # not be set.
 
271
            rename_func(old, new)
 
272
            success = True
 
273
        except (IOError, OSError), e:
 
274
            # source and target may be aliases of each other (e.g. on a
 
275
            # case-insensitive filesystem), so we may have accidentally renamed
 
276
            # source by when we tried to rename target
 
277
            failure_exc = sys.exc_info()
 
278
            if (file_existed and e.errno in (None, errno.ENOENT)
 
279
                and old.lower() == new.lower()):
 
280
                # source and target are the same file on a case-insensitive
 
281
                # filesystem, so we don't generate an exception
 
282
                failure_exc = None
226
283
    finally:
227
284
        if file_existed:
228
285
            # If the file used to exist, rename it back into place
231
288
                unlink_func(tmp_name)
232
289
            else:
233
290
                rename_func(tmp_name, new)
 
291
    if failure_exc is not None:
 
292
        try:
 
293
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
294
        finally:
 
295
            del failure_exc
234
296
 
235
297
 
236
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
237
299
# choke on a Unicode string containing a relative path if
238
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
239
301
# string.
240
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
241
302
def _posix_abspath(path):
242
303
    # jam 20060426 rather than encoding to fsencoding
243
304
    # copy posixpath.abspath, but use os.getcwdu instead
244
305
    if not posixpath.isabs(path):
245
306
        path = posixpath.join(getcwd(), path)
246
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
247
308
 
248
309
 
249
310
def _posix_realpath(path):
250
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
251
312
 
252
313
 
 
314
def _posix_normpath(path):
 
315
    path = posixpath.normpath(path)
 
316
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
317
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
318
    # leading slashes must not be simplified to one, and only if there are 3 or
 
319
    # more should they be simplified as one. So we treat the leading 2 slashes
 
320
    # as a special case here by simply removing the first slash, as we consider
 
321
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
322
    # This is not a paranoid precaution, as we notably get paths like this when
 
323
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
324
    if path.startswith('//'):
 
325
        path = path[1:]
 
326
    return path
 
327
 
 
328
 
 
329
def _posix_path_from_environ(key):
 
330
    """Get unicode path from `key` in environment or None if not present
 
331
 
 
332
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
333
    so a path that raises BadFilenameEncoding here may still be accessible.
 
334
    """
 
335
    val = os.environ.get(key, None)
 
336
    if val is None:
 
337
        return val
 
338
    try:
 
339
        return val.decode(_fs_enc)
 
340
    except UnicodeDecodeError:
 
341
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
342
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
343
 
 
344
 
 
345
def _posix_get_home_dir():
 
346
    """Get the home directory of the current user as a unicode path"""
 
347
    path = posixpath.expanduser("~")
 
348
    try:
 
349
        return path.decode(_fs_enc)
 
350
    except UnicodeDecodeError:
 
351
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
352
 
 
353
 
 
354
def _posix_getuser_unicode():
 
355
    """Get username from environment or password database as unicode"""
 
356
    name = getpass.getuser()
 
357
    user_encoding = get_user_encoding()
 
358
    try:
 
359
        return name.decode(user_encoding)
 
360
    except UnicodeDecodeError:
 
361
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
362
            "application locale." % (name, user_encoding))
 
363
 
 
364
 
253
365
def _win32_fixdrive(path):
254
366
    """Force drive letters to be consistent.
255
367
 
259
371
    running python.exe under cmd.exe return capital C:\\
260
372
    running win32 python inside a cygwin shell returns lowercase c:\\
261
373
    """
262
 
    drive, path = _nt_splitdrive(path)
 
374
    drive, path = ntpath.splitdrive(path)
263
375
    return drive.upper() + path
264
376
 
265
377
 
266
378
def _win32_abspath(path):
267
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
268
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
379
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
380
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
269
381
 
270
382
 
271
383
def _win98_abspath(path):
282
394
    #   /path       => C:/path
283
395
    path = unicode(path)
284
396
    # check for absolute path
285
 
    drive = _nt_splitdrive(path)[0]
 
397
    drive = ntpath.splitdrive(path)[0]
286
398
    if drive == '' and path[:2] not in('//','\\\\'):
287
399
        cwd = os.getcwdu()
288
400
        # we cannot simply os.path.join cwd and path
289
401
        # because os.path.join('C:','/path') produce '/path'
290
402
        # and this is incorrect
291
403
        if path[:1] in ('/','\\'):
292
 
            cwd = _nt_splitdrive(cwd)[0]
 
404
            cwd = ntpath.splitdrive(cwd)[0]
293
405
            path = path[1:]
294
406
        path = cwd + '\\' + path
295
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
296
 
 
297
 
if win32utils.winver == 'Windows 98':
298
 
    _win32_abspath = _win98_abspath
 
407
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
299
408
 
300
409
 
301
410
def _win32_realpath(path):
302
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
303
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
411
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
412
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
304
413
 
305
414
 
306
415
def _win32_pathjoin(*args):
307
 
    return _nt_join(*args).replace('\\', '/')
 
416
    return ntpath.join(*args).replace('\\', '/')
308
417
 
309
418
 
310
419
def _win32_normpath(path):
311
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
420
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
312
421
 
313
422
 
314
423
def _win32_getcwd():
323
432
    """We expect to be able to atomically replace 'new' with old.
324
433
 
325
434
    On win32, if new exists, it must be moved out of the way first,
326
 
    and then deleted. 
 
435
    and then deleted.
327
436
    """
328
437
    try:
329
438
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
330
439
    except OSError, e:
331
440
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
332
 
            # If we try to rename a non-existant file onto cwd, we get 
333
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
441
            # If we try to rename a non-existant file onto cwd, we get
 
442
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
334
443
            # if the old path doesn't exist, sometimes we get EACCES
335
444
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
336
445
            os.lstat(old)
338
447
 
339
448
 
340
449
def _mac_getcwd():
341
 
    return unicodedata.normalize('NFKC', os.getcwdu())
 
450
    return unicodedata.normalize('NFC', os.getcwdu())
342
451
 
343
452
 
344
453
# Default is to just use the python builtins, but these can be rebound on
346
455
abspath = _posix_abspath
347
456
realpath = _posix_realpath
348
457
pathjoin = os.path.join
349
 
normpath = os.path.normpath
 
458
normpath = _posix_normpath
 
459
path_from_environ = _posix_path_from_environ
 
460
_get_home_dir = _posix_get_home_dir
 
461
getuser_unicode = _posix_getuser_unicode
350
462
getcwd = os.getcwdu
351
463
rename = os.rename
352
464
dirname = os.path.dirname
353
465
basename = os.path.basename
354
466
split = os.path.split
355
467
splitext = os.path.splitext
356
 
# These were already imported into local scope
 
468
# These were already lazily imported into local scope
357
469
# mkdtemp = tempfile.mkdtemp
358
470
# rmtree = shutil.rmtree
 
471
lstat = os.lstat
 
472
fstat = os.fstat
 
473
 
 
474
def wrap_stat(st):
 
475
    return st
 
476
 
359
477
 
360
478
MIN_ABS_PATHLENGTH = 1
361
479
 
362
480
 
363
481
if sys.platform == 'win32':
364
 
    abspath = _win32_abspath
 
482
    if win32utils.winver == 'Windows 98':
 
483
        abspath = _win98_abspath
 
484
    else:
 
485
        abspath = _win32_abspath
365
486
    realpath = _win32_realpath
366
487
    pathjoin = _win32_pathjoin
367
488
    normpath = _win32_normpath
368
489
    getcwd = _win32_getcwd
369
490
    mkdtemp = _win32_mkdtemp
370
491
    rename = _win32_rename
 
492
    try:
 
493
        from bzrlib import _walkdirs_win32
 
494
    except ImportError:
 
495
        pass
 
496
    else:
 
497
        lstat = _walkdirs_win32.lstat
 
498
        fstat = _walkdirs_win32.fstat
 
499
        wrap_stat = _walkdirs_win32.wrap_stat
371
500
 
372
501
    MIN_ABS_PATHLENGTH = 3
373
502
 
387
516
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
388
517
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
389
518
        return shutil.rmtree(path, ignore_errors, onerror)
 
519
 
 
520
    f = win32utils.get_unicode_argv     # special function or None
 
521
    if f is not None:
 
522
        get_unicode_argv = f
 
523
    path_from_environ = win32utils.get_environ_unicode
 
524
    _get_home_dir = win32utils.get_home_location
 
525
    getuser_unicode = win32utils.get_user_name
 
526
 
390
527
elif sys.platform == 'darwin':
391
528
    getcwd = _mac_getcwd
392
529
 
393
530
 
394
 
def get_terminal_encoding():
 
531
def get_terminal_encoding(trace=False):
395
532
    """Find the best encoding for printing to the screen.
396
533
 
397
534
    This attempts to check both sys.stdout and sys.stdin to see
398
535
    what encoding they are in, and if that fails it falls back to
399
 
    bzrlib.user_encoding.
 
536
    osutils.get_user_encoding().
400
537
    The problem is that on Windows, locale.getpreferredencoding()
401
538
    is not the same encoding as that used by the console:
402
539
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
403
540
 
404
541
    On my standard US Windows XP, the preferred encoding is
405
542
    cp1252, but the console is cp437
 
543
 
 
544
    :param trace: If True trace the selected encoding via mutter().
406
545
    """
 
546
    from bzrlib.trace import mutter
407
547
    output_encoding = getattr(sys.stdout, 'encoding', None)
408
548
    if not output_encoding:
409
549
        input_encoding = getattr(sys.stdin, 'encoding', None)
410
550
        if not input_encoding:
411
 
            output_encoding = bzrlib.user_encoding
412
 
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
551
            output_encoding = get_user_encoding()
 
552
            if trace:
 
553
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
554
                   output_encoding)
413
555
        else:
414
556
            output_encoding = input_encoding
415
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
557
            if trace:
 
558
                mutter('encoding stdout as sys.stdin encoding %r',
 
559
                    output_encoding)
416
560
    else:
417
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
561
        if trace:
 
562
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
418
563
    if output_encoding == 'cp0':
419
564
        # invalid encoding (cp0 means 'no codepage' on Windows)
420
 
        output_encoding = bzrlib.user_encoding
421
 
        mutter('cp0 is invalid encoding.'
422
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
565
        output_encoding = get_user_encoding()
 
566
        if trace:
 
567
            mutter('cp0 is invalid encoding.'
 
568
               ' encoding stdout as osutils.get_user_encoding() %r',
 
569
               output_encoding)
423
570
    # check encoding
424
571
    try:
425
572
        codecs.lookup(output_encoding)
427
574
        sys.stderr.write('bzr: warning:'
428
575
                         ' unknown terminal encoding %s.\n'
429
576
                         '  Using encoding %s instead.\n'
430
 
                         % (output_encoding, bzrlib.user_encoding)
 
577
                         % (output_encoding, get_user_encoding())
431
578
                        )
432
 
        output_encoding = bzrlib.user_encoding
 
579
        output_encoding = get_user_encoding()
433
580
 
434
581
    return output_encoding
435
582
 
446
593
        return pathjoin(F(p), e)
447
594
 
448
595
 
449
 
def backup_file(fn):
450
 
    """Copy a file to a backup.
451
 
 
452
 
    Backups are named in GNU-style, with a ~ suffix.
453
 
 
454
 
    If the file is already a backup, it's not copied.
455
 
    """
456
 
    if fn[-1] == '~':
457
 
        return
458
 
    bfn = fn + '~'
459
 
 
460
 
    if has_symlinks() and os.path.islink(fn):
461
 
        target = os.readlink(fn)
462
 
        os.symlink(target, bfn)
463
 
        return
464
 
    inf = file(fn, 'rb')
465
 
    try:
466
 
        content = inf.read()
467
 
    finally:
468
 
        inf.close()
469
 
    
470
 
    outf = file(bfn, 'wb')
471
 
    try:
472
 
        outf.write(content)
473
 
    finally:
474
 
        outf.close()
475
 
 
476
 
 
477
596
def isdir(f):
478
597
    """True if f is an accessible directory."""
479
598
    try:
480
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
599
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
481
600
    except OSError:
482
601
        return False
483
602
 
485
604
def isfile(f):
486
605
    """True if f is a regular file."""
487
606
    try:
488
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
607
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
489
608
    except OSError:
490
609
        return False
491
610
 
492
611
def islink(f):
493
612
    """True if f is a symlink."""
494
613
    try:
495
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
614
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
496
615
    except OSError:
497
616
        return False
498
617
 
499
618
def is_inside(dir, fname):
500
619
    """True if fname is inside dir.
501
 
    
 
620
 
502
621
    The parameters should typically be passed to osutils.normpath first, so
503
622
    that . and .. and repeated slashes are eliminated, and the separators
504
623
    are canonical for the platform.
505
 
    
506
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
624
 
 
625
    The empty string as a dir name is taken as top-of-tree and matches
507
626
    everything.
508
627
    """
509
 
    # XXX: Most callers of this can actually do something smarter by 
 
628
    # XXX: Most callers of this can actually do something smarter by
510
629
    # looking at the inventory
511
630
    if dir == fname:
512
631
        return True
513
 
    
 
632
 
514
633
    if dir == '':
515
634
        return True
516
635
 
536
655
    return False
537
656
 
538
657
 
539
 
def pumpfile(fromfile, tofile):
540
 
    """Copy contents of one file to another."""
541
 
    BUFSIZE = 32768
542
 
    while True:
543
 
        b = fromfile.read(BUFSIZE)
544
 
        if not b:
545
 
            break
546
 
        tofile.write(b)
 
658
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
659
             report_activity=None, direction='read'):
 
660
    """Copy contents of one file to another.
 
661
 
 
662
    The read_length can either be -1 to read to end-of-file (EOF) or
 
663
    it can specify the maximum number of bytes to read.
 
664
 
 
665
    The buff_size represents the maximum size for each read operation
 
666
    performed on from_file.
 
667
 
 
668
    :param report_activity: Call this as bytes are read, see
 
669
        Transport._report_activity
 
670
    :param direction: Will be passed to report_activity
 
671
 
 
672
    :return: The number of bytes copied.
 
673
    """
 
674
    length = 0
 
675
    if read_length >= 0:
 
676
        # read specified number of bytes
 
677
 
 
678
        while read_length > 0:
 
679
            num_bytes_to_read = min(read_length, buff_size)
 
680
 
 
681
            block = from_file.read(num_bytes_to_read)
 
682
            if not block:
 
683
                # EOF reached
 
684
                break
 
685
            if report_activity is not None:
 
686
                report_activity(len(block), direction)
 
687
            to_file.write(block)
 
688
 
 
689
            actual_bytes_read = len(block)
 
690
            read_length -= actual_bytes_read
 
691
            length += actual_bytes_read
 
692
    else:
 
693
        # read to EOF
 
694
        while True:
 
695
            block = from_file.read(buff_size)
 
696
            if not block:
 
697
                # EOF reached
 
698
                break
 
699
            if report_activity is not None:
 
700
                report_activity(len(block), direction)
 
701
            to_file.write(block)
 
702
            length += len(block)
 
703
    return length
 
704
 
 
705
 
 
706
def pump_string_file(bytes, file_handle, segment_size=None):
 
707
    """Write bytes to file_handle in many smaller writes.
 
708
 
 
709
    :param bytes: The string to write.
 
710
    :param file_handle: The file to write to.
 
711
    """
 
712
    # Write data in chunks rather than all at once, because very large
 
713
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
714
    # drives).
 
715
    if not segment_size:
 
716
        segment_size = 5242880 # 5MB
 
717
    segments = range(len(bytes) / segment_size + 1)
 
718
    write = file_handle.write
 
719
    for segment_index in segments:
 
720
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
721
        write(segment)
547
722
 
548
723
 
549
724
def file_iterator(input_file, readsize=32768):
555
730
 
556
731
 
557
732
def sha_file(f):
558
 
    if getattr(f, 'tell', None) is not None:
559
 
        assert f.tell() == 0
560
 
    s = sha.new()
 
733
    """Calculate the hexdigest of an open file.
 
734
 
 
735
    The file cursor should be already at the start.
 
736
    """
 
737
    s = sha()
561
738
    BUFSIZE = 128<<10
562
739
    while True:
563
740
        b = f.read(BUFSIZE)
567
744
    return s.hexdigest()
568
745
 
569
746
 
570
 
 
571
 
def sha_strings(strings):
 
747
def size_sha_file(f):
 
748
    """Calculate the size and hexdigest of an open file.
 
749
 
 
750
    The file cursor should be already at the start and
 
751
    the caller is responsible for closing the file afterwards.
 
752
    """
 
753
    size = 0
 
754
    s = sha()
 
755
    BUFSIZE = 128<<10
 
756
    while True:
 
757
        b = f.read(BUFSIZE)
 
758
        if not b:
 
759
            break
 
760
        size += len(b)
 
761
        s.update(b)
 
762
    return size, s.hexdigest()
 
763
 
 
764
 
 
765
def sha_file_by_name(fname):
 
766
    """Calculate the SHA1 of a file by reading the full text"""
 
767
    s = sha()
 
768
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
769
    try:
 
770
        while True:
 
771
            b = os.read(f, 1<<16)
 
772
            if not b:
 
773
                return s.hexdigest()
 
774
            s.update(b)
 
775
    finally:
 
776
        os.close(f)
 
777
 
 
778
 
 
779
def sha_strings(strings, _factory=sha):
572
780
    """Return the sha-1 of concatenation of strings"""
573
 
    s = sha.new()
 
781
    s = _factory()
574
782
    map(s.update, strings)
575
783
    return s.hexdigest()
576
784
 
577
785
 
578
 
def sha_string(f):
579
 
    s = sha.new()
580
 
    s.update(f)
581
 
    return s.hexdigest()
 
786
def sha_string(f, _factory=sha):
 
787
    return _factory(f).hexdigest()
582
788
 
583
789
 
584
790
def fingerprint_file(f):
585
 
    s = sha.new()
586
791
    b = f.read()
587
 
    s.update(b)
588
 
    size = len(b)
589
 
    return {'size': size,
590
 
            'sha1': s.hexdigest()}
 
792
    return {'size': len(b),
 
793
            'sha1': sha(b).hexdigest()}
591
794
 
592
795
 
593
796
def compare_files(a, b):
609
812
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
610
813
    return offset.days * 86400 + offset.seconds
611
814
 
612
 
    
 
815
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
816
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
 
817
 
 
818
 
613
819
def format_date(t, offset=0, timezone='original', date_fmt=None,
614
820
                show_offset=True):
615
821
    """Return a formatted date string.
619
825
    :param timezone: How to display the time: 'utc', 'original' for the
620
826
         timezone specified by offset, or 'local' for the process's current
621
827
         timezone.
622
 
    :param show_offset: Whether to append the timezone.
623
 
    :param date_fmt: strftime format.
624
 
    """
 
828
    :param date_fmt: strftime format.
 
829
    :param show_offset: Whether to append the timezone.
 
830
    """
 
831
    (date_fmt, tt, offset_str) = \
 
832
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
833
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
834
    date_str = time.strftime(date_fmt, tt)
 
835
    return date_str + offset_str
 
836
 
 
837
 
 
838
# Cache of formatted offset strings
 
839
_offset_cache = {}
 
840
 
 
841
 
 
842
def format_date_with_offset_in_original_timezone(t, offset=0,
 
843
    _cache=_offset_cache):
 
844
    """Return a formatted date string in the original timezone.
 
845
 
 
846
    This routine may be faster then format_date.
 
847
 
 
848
    :param t: Seconds since the epoch.
 
849
    :param offset: Timezone offset in seconds east of utc.
 
850
    """
 
851
    if offset is None:
 
852
        offset = 0
 
853
    tt = time.gmtime(t + offset)
 
854
    date_fmt = _default_format_by_weekday_num[tt[6]]
 
855
    date_str = time.strftime(date_fmt, tt)
 
856
    offset_str = _cache.get(offset, None)
 
857
    if offset_str is None:
 
858
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
859
        _cache[offset] = offset_str
 
860
    return date_str + offset_str
 
861
 
 
862
 
 
863
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
864
                      show_offset=True):
 
865
    """Return an unicode date string formatted according to the current locale.
 
866
 
 
867
    :param t: Seconds since the epoch.
 
868
    :param offset: Timezone offset in seconds east of utc.
 
869
    :param timezone: How to display the time: 'utc', 'original' for the
 
870
         timezone specified by offset, or 'local' for the process's current
 
871
         timezone.
 
872
    :param date_fmt: strftime format.
 
873
    :param show_offset: Whether to append the timezone.
 
874
    """
 
875
    (date_fmt, tt, offset_str) = \
 
876
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
877
    date_str = time.strftime(date_fmt, tt)
 
878
    if not isinstance(date_str, unicode):
 
879
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
880
    return date_str + offset_str
 
881
 
 
882
 
 
883
def _format_date(t, offset, timezone, date_fmt, show_offset):
625
884
    if timezone == 'utc':
626
885
        tt = time.gmtime(t)
627
886
        offset = 0
633
892
        tt = time.localtime(t)
634
893
        offset = local_time_offset(t)
635
894
    else:
636
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
637
 
                              ['options are "utc", "original", "local"'])
 
895
        raise errors.UnsupportedTimezoneFormat(timezone)
638
896
    if date_fmt is None:
639
897
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
640
898
    if show_offset:
641
899
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
642
900
    else:
643
901
        offset_str = ''
644
 
    return (time.strftime(date_fmt, tt) +  offset_str)
 
902
    return (date_fmt, tt, offset_str)
645
903
 
646
904
 
647
905
def compact_date(when):
648
906
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
649
 
    
 
907
 
650
908
 
651
909
def format_delta(delta):
652
910
    """Get a nice looking string for a time delta.
699
957
 
700
958
def filesize(f):
701
959
    """Return size of given open file."""
702
 
    return os.fstat(f.fileno())[ST_SIZE]
703
 
 
704
 
 
705
 
# Define rand_bytes based on platform.
706
 
try:
707
 
    # Python 2.4 and later have os.urandom,
708
 
    # but it doesn't work on some arches
709
 
    os.urandom(1)
710
 
    rand_bytes = os.urandom
711
 
except (NotImplementedError, AttributeError):
712
 
    # If python doesn't have os.urandom, or it doesn't work,
713
 
    # then try to first pull random data from /dev/urandom
 
960
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
961
 
 
962
 
 
963
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
964
# override if it doesn't work. Avoid checking on windows where there is
 
965
# significant initialisation cost that can be avoided for some bzr calls.
 
966
 
 
967
rand_bytes = os.urandom
 
968
 
 
969
if rand_bytes.__module__ != "nt":
714
970
    try:
715
 
        rand_bytes = file('/dev/urandom', 'rb').read
716
 
    # Otherwise, use this hack as a last resort
717
 
    except (IOError, OSError):
 
971
        rand_bytes(1)
 
972
    except NotImplementedError:
718
973
        # not well seeded, but better than nothing
719
974
        def rand_bytes(n):
720
975
            import random
728
983
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
729
984
def rand_chars(num):
730
985
    """Return a random string of num alphanumeric characters
731
 
    
732
 
    The result only contains lowercase chars because it may be used on 
 
986
 
 
987
    The result only contains lowercase chars because it may be used on
733
988
    case-insensitive filesystems.
734
989
    """
735
990
    s = ''
743
998
 
744
999
def splitpath(p):
745
1000
    """Turn string into list of parts."""
746
 
    assert isinstance(p, basestring)
747
 
 
748
1001
    # split on either delimiter because people might use either on
749
1002
    # Windows
750
1003
    ps = re.split(r'[\\/]', p)
752
1005
    rps = []
753
1006
    for f in ps:
754
1007
        if f == '..':
755
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
756
1009
        elif (f == '.') or (f == ''):
757
1010
            pass
758
1011
        else:
759
1012
            rps.append(f)
760
1013
    return rps
761
1014
 
 
1015
 
762
1016
def joinpath(p):
763
 
    assert isinstance(p, (list, tuple))
764
1017
    for f in p:
765
1018
        if (f == '..') or (f is None) or (f == ''):
766
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1019
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
767
1020
    return pathjoin(*p)
768
1021
 
769
1022
 
 
1023
def parent_directories(filename):
 
1024
    """Return the list of parent directories, deepest first.
 
1025
 
 
1026
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
1027
    """
 
1028
    parents = []
 
1029
    parts = splitpath(dirname(filename))
 
1030
    while parts:
 
1031
        parents.append(joinpath(parts))
 
1032
        parts.pop()
 
1033
    return parents
 
1034
 
 
1035
 
 
1036
_extension_load_failures = []
 
1037
 
 
1038
 
 
1039
def failed_to_load_extension(exception):
 
1040
    """Handle failing to load a binary extension.
 
1041
 
 
1042
    This should be called from the ImportError block guarding the attempt to
 
1043
    import the native extension.  If this function returns, the pure-Python
 
1044
    implementation should be loaded instead::
 
1045
 
 
1046
    >>> try:
 
1047
    >>>     import bzrlib._fictional_extension_pyx
 
1048
    >>> except ImportError, e:
 
1049
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
1050
    >>>     import bzrlib._fictional_extension_py
 
1051
    """
 
1052
    # NB: This docstring is just an example, not a doctest, because doctest
 
1053
    # currently can't cope with the use of lazy imports in this namespace --
 
1054
    # mbp 20090729
 
1055
 
 
1056
    # This currently doesn't report the failure at the time it occurs, because
 
1057
    # they tend to happen very early in startup when we can't check config
 
1058
    # files etc, and also we want to report all failures but not spam the user
 
1059
    # with 10 warnings.
 
1060
    exception_str = str(exception)
 
1061
    if exception_str not in _extension_load_failures:
 
1062
        trace.mutter("failed to load compiled extension: %s" % exception_str)
 
1063
        _extension_load_failures.append(exception_str)
 
1064
 
 
1065
 
 
1066
def report_extension_load_failures():
 
1067
    if not _extension_load_failures:
 
1068
        return
 
1069
    if config.GlobalStack().get('ignore_missing_extensions'):
 
1070
        return
 
1071
    # the warnings framework should by default show this only once
 
1072
    from bzrlib.trace import warning
 
1073
    warning(
 
1074
        "bzr: warning: some compiled extensions could not be loaded; "
 
1075
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
1076
    # we no longer show the specific missing extensions here, because it makes
 
1077
    # the message too long and scary - see
 
1078
    # https://bugs.launchpad.net/bzr/+bug/430529
 
1079
 
 
1080
 
 
1081
try:
 
1082
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1083
except ImportError, e:
 
1084
    failed_to_load_extension(e)
 
1085
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1086
 
 
1087
 
770
1088
def split_lines(s):
771
1089
    """Split s into lines, but without removing the newline characters."""
 
1090
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
1091
    # chunks_to_lines do the heavy lifting.
 
1092
    if isinstance(s, str):
 
1093
        # chunks_to_lines only supports 8-bit strings
 
1094
        return chunks_to_lines([s])
 
1095
    else:
 
1096
        return _split_lines(s)
 
1097
 
 
1098
 
 
1099
def _split_lines(s):
 
1100
    """Split s into lines, but without removing the newline characters.
 
1101
 
 
1102
    This supports Unicode or plain string objects.
 
1103
    """
772
1104
    lines = s.split('\n')
773
1105
    result = [line + '\n' for line in lines[:-1]]
774
1106
    if lines[-1]:
792
1124
            raise
793
1125
        shutil.copyfile(src, dest)
794
1126
 
795
 
def delete_any(full_path):
796
 
    """Delete a file or directory."""
 
1127
 
 
1128
def delete_any(path):
 
1129
    """Delete a file, symlink or directory.
 
1130
 
 
1131
    Will delete even if readonly.
 
1132
    """
797
1133
    try:
798
 
        os.unlink(full_path)
799
 
    except OSError, e:
800
 
    # We may be renaming a dangling inventory id
801
 
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
1134
       _delete_file_or_dir(path)
 
1135
    except (OSError, IOError), e:
 
1136
        if e.errno in (errno.EPERM, errno.EACCES):
 
1137
            # make writable and try again
 
1138
            try:
 
1139
                make_writable(path)
 
1140
            except (OSError, IOError):
 
1141
                pass
 
1142
            _delete_file_or_dir(path)
 
1143
        else:
802
1144
            raise
803
 
        os.rmdir(full_path)
 
1145
 
 
1146
 
 
1147
def _delete_file_or_dir(path):
 
1148
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
1149
    # Forgiveness than Permission (EAFP) because:
 
1150
    # - root can damage a solaris file system by using unlink,
 
1151
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
1152
    #   EACCES, OSX: EPERM) when invoked on a directory.
 
1153
    if isdir(path): # Takes care of symlinks
 
1154
        os.rmdir(path)
 
1155
    else:
 
1156
        os.unlink(path)
804
1157
 
805
1158
 
806
1159
def has_symlinks():
808
1161
        return True
809
1162
    else:
810
1163
        return False
811
 
        
 
1164
 
 
1165
 
 
1166
def has_hardlinks():
 
1167
    if getattr(os, 'link', None) is not None:
 
1168
        return True
 
1169
    else:
 
1170
        return False
 
1171
 
 
1172
 
 
1173
def host_os_dereferences_symlinks():
 
1174
    return (has_symlinks()
 
1175
            and sys.platform not in ('cygwin', 'win32'))
 
1176
 
 
1177
 
 
1178
def readlink(abspath):
 
1179
    """Return a string representing the path to which the symbolic link points.
 
1180
 
 
1181
    :param abspath: The link absolute unicode path.
 
1182
 
 
1183
    This his guaranteed to return the symbolic link in unicode in all python
 
1184
    versions.
 
1185
    """
 
1186
    link = abspath.encode(_fs_enc)
 
1187
    target = os.readlink(link)
 
1188
    target = target.decode(_fs_enc)
 
1189
    return target
 
1190
 
812
1191
 
813
1192
def contains_whitespace(s):
814
1193
    """True if there are any whitespace characters in s."""
840
1219
 
841
1220
 
842
1221
def relpath(base, path):
843
 
    """Return path relative to base, or raise exception.
 
1222
    """Return path relative to base, or raise PathNotChild exception.
844
1223
 
845
1224
    The path may be either an absolute path or a path relative to the
846
1225
    current working directory.
848
1227
    os.path.commonprefix (python2.4) has a bad bug that it works just
849
1228
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
850
1229
    avoids that problem.
 
1230
 
 
1231
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1232
    PathNotChild exceptions regardless of `path`.
851
1233
    """
852
1234
 
853
 
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
854
 
        ' exceed the platform minimum length (which is %d)' % 
855
 
        MIN_ABS_PATHLENGTH)
 
1235
    if len(base) < MIN_ABS_PATHLENGTH:
 
1236
        # must have space for e.g. a drive letter
 
1237
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1238
            % (base,))
856
1239
 
857
1240
    rp = abspath(path)
858
1241
 
859
1242
    s = []
860
1243
    head = rp
861
 
    while len(head) >= len(base):
 
1244
    while True:
 
1245
        if len(head) <= len(base) and head != base:
 
1246
            raise errors.PathNotChild(rp, base)
862
1247
        if head == base:
863
1248
            break
864
 
        head, tail = os.path.split(head)
 
1249
        head, tail = split(head)
865
1250
        if tail:
866
 
            s.insert(0, tail)
867
 
    else:
868
 
        raise errors.PathNotChild(rp, base)
 
1251
            s.append(tail)
869
1252
 
870
1253
    if s:
871
 
        return pathjoin(*s)
 
1254
        return pathjoin(*reversed(s))
872
1255
    else:
873
1256
        return ''
874
1257
 
875
1258
 
 
1259
def _cicp_canonical_relpath(base, path):
 
1260
    """Return the canonical path relative to base.
 
1261
 
 
1262
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1263
    will return the relpath as stored on the file-system rather than in the
 
1264
    case specified in the input string, for all existing portions of the path.
 
1265
 
 
1266
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1267
    have a number of paths to convert, you should use canonical_relpaths().
 
1268
    """
 
1269
    # TODO: it should be possible to optimize this for Windows by using the
 
1270
    # win32 API FindFiles function to look for the specified name - but using
 
1271
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1272
    # the short term.
 
1273
 
 
1274
    rel = relpath(base, path)
 
1275
    # '.' will have been turned into ''
 
1276
    if not rel:
 
1277
        return rel
 
1278
 
 
1279
    abs_base = abspath(base)
 
1280
    current = abs_base
 
1281
    _listdir = os.listdir
 
1282
 
 
1283
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1284
    bit_iter = iter(rel.split('/'))
 
1285
    for bit in bit_iter:
 
1286
        lbit = bit.lower()
 
1287
        try:
 
1288
            next_entries = _listdir(current)
 
1289
        except OSError: # enoent, eperm, etc
 
1290
            # We can't find this in the filesystem, so just append the
 
1291
            # remaining bits.
 
1292
            current = pathjoin(current, bit, *list(bit_iter))
 
1293
            break
 
1294
        for look in next_entries:
 
1295
            if lbit == look.lower():
 
1296
                current = pathjoin(current, look)
 
1297
                break
 
1298
        else:
 
1299
            # got to the end, nothing matched, so we just return the
 
1300
            # non-existing bits as they were specified (the filename may be
 
1301
            # the target of a move, for example).
 
1302
            current = pathjoin(current, bit, *list(bit_iter))
 
1303
            break
 
1304
    return current[len(abs_base):].lstrip('/')
 
1305
 
 
1306
# XXX - TODO - we need better detection/integration of case-insensitive
 
1307
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1308
# filesystems), for example, so could probably benefit from the same basic
 
1309
# support there.  For now though, only Windows and OSX get that support, and
 
1310
# they get it for *all* file-systems!
 
1311
if sys.platform in ('win32', 'darwin'):
 
1312
    canonical_relpath = _cicp_canonical_relpath
 
1313
else:
 
1314
    canonical_relpath = relpath
 
1315
 
 
1316
def canonical_relpaths(base, paths):
 
1317
    """Create an iterable to canonicalize a sequence of relative paths.
 
1318
 
 
1319
    The intent is for this implementation to use a cache, vastly speeding
 
1320
    up multiple transformations in the same directory.
 
1321
    """
 
1322
    # but for now, we haven't optimized...
 
1323
    return [canonical_relpath(base, p) for p in paths]
 
1324
 
 
1325
 
 
1326
def decode_filename(filename):
 
1327
    """Decode the filename using the filesystem encoding
 
1328
 
 
1329
    If it is unicode, it is returned.
 
1330
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1331
    fails, a errors.BadFilenameEncoding exception is raised.
 
1332
    """
 
1333
    if type(filename) is unicode:
 
1334
        return filename
 
1335
    try:
 
1336
        return filename.decode(_fs_enc)
 
1337
    except UnicodeDecodeError:
 
1338
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1339
 
 
1340
 
876
1341
def safe_unicode(unicode_or_utf8_string):
877
1342
    """Coerce unicode_or_utf8_string into unicode.
878
1343
 
879
1344
    If it is unicode, it is returned.
880
 
    Otherwise it is decoded from utf-8. If a decoding error
881
 
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
882
 
    as a BzrBadParameter exception.
 
1345
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1346
    wrapped in a BzrBadParameterNotUnicode exception.
883
1347
    """
884
1348
    if isinstance(unicode_or_utf8_string, unicode):
885
1349
        return unicode_or_utf8_string
962
1426
def normalizes_filenames():
963
1427
    """Return True if this platform normalizes unicode filenames.
964
1428
 
965
 
    Mac OSX does, Windows/Linux do not.
 
1429
    Only Mac OSX.
966
1430
    """
967
1431
    return _platform_normalizes_filenames
968
1432
 
972
1436
 
973
1437
    On platforms where the system normalizes filenames (Mac OSX),
974
1438
    you can access a file by any path which will normalize correctly.
975
 
    On platforms where the system does not normalize filenames 
976
 
    (Windows, Linux), you have to access a file by its exact path.
 
1439
    On platforms where the system does not normalize filenames
 
1440
    (everything else), you have to access a file by its exact path.
977
1441
 
978
 
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
1442
    Internally, bzr only supports NFC normalization, since that is
979
1443
    the standard for XML documents.
980
1444
 
981
1445
    So return the normalized path, and a flag indicating if the file
982
1446
    can be accessed by that path.
983
1447
    """
984
1448
 
985
 
    return unicodedata.normalize('NFKC', unicode(path)), True
 
1449
    return unicodedata.normalize('NFC', unicode(path)), True
986
1450
 
987
1451
 
988
1452
def _inaccessible_normalized_filename(path):
989
1453
    __doc__ = _accessible_normalized_filename.__doc__
990
1454
 
991
 
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
1455
    normalized = unicodedata.normalize('NFC', unicode(path))
992
1456
    return normalized, normalized == path
993
1457
 
994
1458
 
998
1462
    normalized_filename = _inaccessible_normalized_filename
999
1463
 
1000
1464
 
 
1465
def set_signal_handler(signum, handler, restart_syscall=True):
 
1466
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1467
    on platforms that support that.
 
1468
 
 
1469
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1470
        automatically restart (by calling `signal.siginterrupt(signum,
 
1471
        False)`).  May be ignored if the feature is not available on this
 
1472
        platform or Python version.
 
1473
    """
 
1474
    try:
 
1475
        import signal
 
1476
        siginterrupt = signal.siginterrupt
 
1477
    except ImportError:
 
1478
        # This python implementation doesn't provide signal support, hence no
 
1479
        # handler exists
 
1480
        return None
 
1481
    except AttributeError:
 
1482
        # siginterrupt doesn't exist on this platform, or for this version
 
1483
        # of Python.
 
1484
        siginterrupt = lambda signum, flag: None
 
1485
    if restart_syscall:
 
1486
        def sig_handler(*args):
 
1487
            # Python resets the siginterrupt flag when a signal is
 
1488
            # received.  <http://bugs.python.org/issue8354>
 
1489
            # As a workaround for some cases, set it back the way we want it.
 
1490
            siginterrupt(signum, False)
 
1491
            # Now run the handler function passed to set_signal_handler.
 
1492
            handler(*args)
 
1493
    else:
 
1494
        sig_handler = handler
 
1495
    old_handler = signal.signal(signum, sig_handler)
 
1496
    if restart_syscall:
 
1497
        siginterrupt(signum, False)
 
1498
    return old_handler
 
1499
 
 
1500
 
 
1501
default_terminal_width = 80
 
1502
"""The default terminal width for ttys.
 
1503
 
 
1504
This is defined so that higher levels can share a common fallback value when
 
1505
terminal_width() returns None.
 
1506
"""
 
1507
 
 
1508
# Keep some state so that terminal_width can detect if _terminal_size has
 
1509
# returned a different size since the process started.  See docstring and
 
1510
# comments of terminal_width for details.
 
1511
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1512
_terminal_size_state = 'no_data'
 
1513
_first_terminal_size = None
 
1514
 
1001
1515
def terminal_width():
1002
 
    """Return estimated terminal width."""
1003
 
    if sys.platform == 'win32':
1004
 
        return win32utils.get_console_size()[0]
1005
 
    width = 0
 
1516
    """Return terminal width.
 
1517
 
 
1518
    None is returned if the width can't established precisely.
 
1519
 
 
1520
    The rules are:
 
1521
    - if BZR_COLUMNS is set, returns its value
 
1522
    - if there is no controlling terminal, returns None
 
1523
    - query the OS, if the queried size has changed since the last query,
 
1524
      return its value,
 
1525
    - if COLUMNS is set, returns its value,
 
1526
    - if the OS has a value (even though it's never changed), return its value.
 
1527
 
 
1528
    From there, we need to query the OS to get the size of the controlling
 
1529
    terminal.
 
1530
 
 
1531
    On Unices we query the OS by:
 
1532
    - get termios.TIOCGWINSZ
 
1533
    - if an error occurs or a negative value is obtained, returns None
 
1534
 
 
1535
    On Windows we query the OS by:
 
1536
    - win32utils.get_console_size() decides,
 
1537
    - returns None on error (provided default value)
 
1538
    """
 
1539
    # Note to implementors: if changing the rules for determining the width,
 
1540
    # make sure you've considered the behaviour in these cases:
 
1541
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1542
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1543
    #    0,0.
 
1544
    #  - (add more interesting cases here, if you find any)
 
1545
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1546
    # but we don't want to register a signal handler because it is impossible
 
1547
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1548
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1549
    # time so we can notice if the reported size has changed, which should have
 
1550
    # a similar effect.
 
1551
 
 
1552
    # If BZR_COLUMNS is set, take it, user is always right
 
1553
    # Except if they specified 0 in which case, impose no limit here
 
1554
    try:
 
1555
        width = int(os.environ['BZR_COLUMNS'])
 
1556
    except (KeyError, ValueError):
 
1557
        width = None
 
1558
    if width is not None:
 
1559
        if width > 0:
 
1560
            return width
 
1561
        else:
 
1562
            return None
 
1563
 
 
1564
    isatty = getattr(sys.stdout, 'isatty', None)
 
1565
    if isatty is None or not isatty():
 
1566
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1567
        return None
 
1568
 
 
1569
    # Query the OS
 
1570
    width, height = os_size = _terminal_size(None, None)
 
1571
    global _first_terminal_size, _terminal_size_state
 
1572
    if _terminal_size_state == 'no_data':
 
1573
        _first_terminal_size = os_size
 
1574
        _terminal_size_state = 'unchanged'
 
1575
    elif (_terminal_size_state == 'unchanged' and
 
1576
          _first_terminal_size != os_size):
 
1577
        _terminal_size_state = 'changed'
 
1578
 
 
1579
    # If the OS claims to know how wide the terminal is, and this value has
 
1580
    # ever changed, use that.
 
1581
    if _terminal_size_state == 'changed':
 
1582
        if width is not None and width > 0:
 
1583
            return width
 
1584
 
 
1585
    # If COLUMNS is set, use it.
 
1586
    try:
 
1587
        return int(os.environ['COLUMNS'])
 
1588
    except (KeyError, ValueError):
 
1589
        pass
 
1590
 
 
1591
    # Finally, use an unchanged size from the OS, if we have one.
 
1592
    if _terminal_size_state == 'unchanged':
 
1593
        if width is not None and width > 0:
 
1594
            return width
 
1595
 
 
1596
    # The width could not be determined.
 
1597
    return None
 
1598
 
 
1599
 
 
1600
def _win32_terminal_size(width, height):
 
1601
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
 
1602
    return width, height
 
1603
 
 
1604
 
 
1605
def _ioctl_terminal_size(width, height):
1006
1606
    try:
1007
1607
        import struct, fcntl, termios
1008
1608
        s = struct.pack('HHHH', 0, 0, 0, 0)
1009
1609
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1010
 
        width = struct.unpack('HHHH', x)[1]
1011
 
    except IOError:
 
1610
        height, width = struct.unpack('HHHH', x)[0:2]
 
1611
    except (IOError, AttributeError):
1012
1612
        pass
1013
 
    if width <= 0:
1014
 
        try:
1015
 
            width = int(os.environ['COLUMNS'])
1016
 
        except:
1017
 
            pass
1018
 
    if width <= 0:
1019
 
        width = 80
1020
 
 
1021
 
    return width
 
1613
    return width, height
 
1614
 
 
1615
_terminal_size = None
 
1616
"""Returns the terminal size as (width, height).
 
1617
 
 
1618
:param width: Default value for width.
 
1619
:param height: Default value for height.
 
1620
 
 
1621
This is defined specifically for each OS and query the size of the controlling
 
1622
terminal. If any error occurs, the provided default values should be returned.
 
1623
"""
 
1624
if sys.platform == 'win32':
 
1625
    _terminal_size = _win32_terminal_size
 
1626
else:
 
1627
    _terminal_size = _ioctl_terminal_size
1022
1628
 
1023
1629
 
1024
1630
def supports_executable():
1052
1658
            del os.environ[env_variable]
1053
1659
    else:
1054
1660
        if isinstance(value, unicode):
1055
 
            value = value.encode(bzrlib.user_encoding)
 
1661
            value = value.encode(get_user_encoding())
1056
1662
        os.environ[env_variable] = value
1057
1663
    return orig_val
1058
1664
 
1061
1667
 
1062
1668
 
1063
1669
def check_legal_path(path):
1064
 
    """Check whether the supplied path is legal.  
 
1670
    """Check whether the supplied path is legal.
1065
1671
    This is only required on Windows, so we don't test on other platforms
1066
1672
    right now.
1067
1673
    """
1071
1677
        raise errors.IllegalPath(path)
1072
1678
 
1073
1679
 
 
1680
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1681
 
 
1682
def _is_error_enotdir(e):
 
1683
    """Check if this exception represents ENOTDIR.
 
1684
 
 
1685
    Unfortunately, python is very inconsistent about the exception
 
1686
    here. The cases are:
 
1687
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1688
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1689
         which is the windows error code.
 
1690
      3) Windows, Python2.5 uses errno == EINVAL and
 
1691
         winerror == ERROR_DIRECTORY
 
1692
 
 
1693
    :param e: An Exception object (expected to be OSError with an errno
 
1694
        attribute, but we should be able to cope with anything)
 
1695
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1696
    """
 
1697
    en = getattr(e, 'errno', None)
 
1698
    if (en == errno.ENOTDIR
 
1699
        or (sys.platform == 'win32'
 
1700
            and (en == _WIN32_ERROR_DIRECTORY
 
1701
                 or (en == errno.EINVAL
 
1702
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1703
        ))):
 
1704
        return True
 
1705
    return False
 
1706
 
 
1707
 
1074
1708
def walkdirs(top, prefix=""):
1075
1709
    """Yield data about all the directories in a tree.
1076
 
    
 
1710
 
1077
1711
    This yields all the data about the contents of a directory at a time.
1078
1712
    After each directory has been yielded, if the caller has mutated the list
1079
1713
    to exclude some directories, they are then not descended into.
1080
 
    
 
1714
 
1081
1715
    The data yielded is of the form:
1082
1716
    ((directory-relpath, directory-path-from-top),
1083
1717
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1084
1718
     - directory-relpath is the relative path of the directory being returned
1085
1719
       with respect to top. prefix is prepended to this.
1086
 
     - directory-path-from-root is the path including top for this directory. 
 
1720
     - directory-path-from-root is the path including top for this directory.
1087
1721
       It is suitable for use with os functions.
1088
1722
     - relpath is the relative path within the subtree being walked.
1089
1723
     - basename is the basename of the path
1091
1725
       present within the tree - but it may be recorded as versioned. See
1092
1726
       versioned_kind.
1093
1727
     - lstat is the stat data *if* the file was statted.
1094
 
     - planned, not implemented: 
 
1728
     - planned, not implemented:
1095
1729
       path_from_tree_root is the path from the root of the tree.
1096
1730
 
1097
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1731
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1098
1732
        allows one to walk a subtree but get paths that are relative to a tree
1099
1733
        rooted higher up.
1100
1734
    :return: an iterator over the dirs.
1101
1735
    """
1102
1736
    #TODO there is a bit of a smell where the results of the directory-
1103
 
    # summary in this, and the path from the root, may not agree 
 
1737
    # summary in this, and the path from the root, may not agree
1104
1738
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1105
1739
    # potentially confusing output. We should make this more robust - but
1106
1740
    # not at a speed cost. RBC 20060731
1107
1741
    _lstat = os.lstat
1108
1742
    _directory = _directory_kind
1109
1743
    _listdir = os.listdir
1110
 
    _kind_from_mode = _formats.get
 
1744
    _kind_from_mode = file_kind_from_stat_mode
1111
1745
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1112
1746
    while pending:
1113
1747
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1120
1754
 
1121
1755
        dirblock = []
1122
1756
        append = dirblock.append
1123
 
        for name in sorted(_listdir(top)):
1124
 
            abspath = top_slash + name
1125
 
            statvalue = _lstat(abspath)
1126
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1127
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1757
        try:
 
1758
            names = sorted(map(decode_filename, _listdir(top)))
 
1759
        except OSError, e:
 
1760
            if not _is_error_enotdir(e):
 
1761
                raise
 
1762
        else:
 
1763
            for name in names:
 
1764
                abspath = top_slash + name
 
1765
                statvalue = _lstat(abspath)
 
1766
                kind = _kind_from_mode(statvalue.st_mode)
 
1767
                append((relprefix + name, name, kind, statvalue, abspath))
1128
1768
        yield (relroot, top), dirblock
1129
1769
 
1130
1770
        # push the user specified dirs from dirblock
1131
1771
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1132
1772
 
1133
1773
 
 
1774
class DirReader(object):
 
1775
    """An interface for reading directories."""
 
1776
 
 
1777
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1778
        """Converts top and prefix to a starting dir entry
 
1779
 
 
1780
        :param top: A utf8 path
 
1781
        :param prefix: An optional utf8 path to prefix output relative paths
 
1782
            with.
 
1783
        :return: A tuple starting with prefix, and ending with the native
 
1784
            encoding of top.
 
1785
        """
 
1786
        raise NotImplementedError(self.top_prefix_to_starting_dir)
 
1787
 
 
1788
    def read_dir(self, prefix, top):
 
1789
        """Read a specific dir.
 
1790
 
 
1791
        :param prefix: A utf8 prefix to be preprended to the path basenames.
 
1792
        :param top: A natively encoded path to read.
 
1793
        :return: A list of the directories contents. Each item contains:
 
1794
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
 
1795
        """
 
1796
        raise NotImplementedError(self.read_dir)
 
1797
 
 
1798
 
 
1799
_selected_dir_reader = None
 
1800
 
 
1801
 
1134
1802
def _walkdirs_utf8(top, prefix=""):
1135
1803
    """Yield data about all the directories in a tree.
1136
1804
 
1145
1813
        path-from-top might be unicode or utf8, but it is the correct path to
1146
1814
        pass to os functions to affect the file in question. (such as os.lstat)
1147
1815
    """
1148
 
    fs_encoding = _fs_enc.upper()
1149
 
    if (sys.platform == 'win32' or
1150
 
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1151
 
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1152
 
    else:
1153
 
        return _walkdirs_fs_utf8(top, prefix=prefix)
1154
 
 
1155
 
 
1156
 
def _walkdirs_fs_utf8(top, prefix=""):
1157
 
    """See _walkdirs_utf8.
1158
 
 
1159
 
    This sub-function is called when we know the filesystem is already in utf8
1160
 
    encoding. So we don't need to transcode filenames.
1161
 
    """
1162
 
    _lstat = os.lstat
1163
 
    _directory = _directory_kind
1164
 
    _listdir = os.listdir
1165
 
    _kind_from_mode = _formats.get
 
1816
    global _selected_dir_reader
 
1817
    if _selected_dir_reader is None:
 
1818
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1819
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1820
            # TODO: We possibly could support Win98 by falling back to the
 
1821
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1822
            #       but that gets a bit tricky, and requires custom compiling
 
1823
            #       for win98 anyway.
 
1824
            try:
 
1825
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1826
                _selected_dir_reader = Win32ReadDir()
 
1827
            except ImportError:
 
1828
                pass
 
1829
        elif _fs_enc in ('utf-8', 'ascii'):
 
1830
            try:
 
1831
                from bzrlib._readdir_pyx import UTF8DirReader
 
1832
                _selected_dir_reader = UTF8DirReader()
 
1833
            except ImportError, e:
 
1834
                failed_to_load_extension(e)
 
1835
                pass
 
1836
 
 
1837
    if _selected_dir_reader is None:
 
1838
        # Fallback to the python version
 
1839
        _selected_dir_reader = UnicodeDirReader()
1166
1840
 
1167
1841
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1168
1842
    # But we don't actually uses 1-3 in pending, so set them to None
1169
 
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1843
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
 
1844
    read_dir = _selected_dir_reader.read_dir
 
1845
    _directory = _directory_kind
1170
1846
    while pending:
1171
 
        relroot, _, _, _, top = pending.pop()
1172
 
        if relroot:
1173
 
            relprefix = relroot + '/'
1174
 
        else:
1175
 
            relprefix = ''
1176
 
        top_slash = top + '/'
1177
 
 
1178
 
        dirblock = []
1179
 
        append = dirblock.append
1180
 
        for name in sorted(_listdir(top)):
1181
 
            abspath = top_slash + name
1182
 
            statvalue = _lstat(abspath)
1183
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1184
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1847
        relroot, _, _, _, top = pending[-1].pop()
 
1848
        if not pending[-1]:
 
1849
            pending.pop()
 
1850
        dirblock = sorted(read_dir(relroot, top))
1185
1851
        yield (relroot, top), dirblock
1186
 
 
1187
1852
        # push the user specified dirs from dirblock
1188
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1189
 
 
1190
 
 
1191
 
def _walkdirs_unicode_to_utf8(top, prefix=""):
1192
 
    """See _walkdirs_utf8
1193
 
 
1194
 
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1195
 
    Unicode paths.
1196
 
    This is currently the fallback code path when the filesystem encoding is
1197
 
    not UTF-8. It may be better to implement an alternative so that we can
1198
 
    safely handle paths that are not properly decodable in the current
1199
 
    encoding.
1200
 
    """
1201
 
    _utf8_encode = codecs.getencoder('utf8')
1202
 
    _lstat = os.lstat
1203
 
    _directory = _directory_kind
1204
 
    _listdir = os.listdir
1205
 
    _kind_from_mode = _formats.get
1206
 
 
1207
 
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1208
 
    while pending:
1209
 
        relroot, _, _, _, top = pending.pop()
1210
 
        if relroot:
1211
 
            relprefix = relroot + '/'
 
1853
        next = [d for d in reversed(dirblock) if d[2] == _directory]
 
1854
        if next:
 
1855
            pending.append(next)
 
1856
 
 
1857
 
 
1858
class UnicodeDirReader(DirReader):
 
1859
    """A dir reader for non-utf8 file systems, which transcodes."""
 
1860
 
 
1861
    __slots__ = ['_utf8_encode']
 
1862
 
 
1863
    def __init__(self):
 
1864
        self._utf8_encode = codecs.getencoder('utf8')
 
1865
 
 
1866
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1867
        """See DirReader.top_prefix_to_starting_dir."""
 
1868
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
 
1869
 
 
1870
    def read_dir(self, prefix, top):
 
1871
        """Read a single directory from a non-utf8 file system.
 
1872
 
 
1873
        top, and the abspath element in the output are unicode, all other paths
 
1874
        are utf8. Local disk IO is done via unicode calls to listdir etc.
 
1875
 
 
1876
        This is currently the fallback code path when the filesystem encoding is
 
1877
        not UTF-8. It may be better to implement an alternative so that we can
 
1878
        safely handle paths that are not properly decodable in the current
 
1879
        encoding.
 
1880
 
 
1881
        See DirReader.read_dir for details.
 
1882
        """
 
1883
        _utf8_encode = self._utf8_encode
 
1884
        _lstat = os.lstat
 
1885
        _listdir = os.listdir
 
1886
        _kind_from_mode = file_kind_from_stat_mode
 
1887
 
 
1888
        if prefix:
 
1889
            relprefix = prefix + '/'
1212
1890
        else:
1213
1891
            relprefix = ''
1214
1892
        top_slash = top + u'/'
1216
1894
        dirblock = []
1217
1895
        append = dirblock.append
1218
1896
        for name in sorted(_listdir(top)):
1219
 
            name_utf8 = _utf8_encode(name)[0]
 
1897
            try:
 
1898
                name_utf8 = _utf8_encode(name)[0]
 
1899
            except UnicodeDecodeError:
 
1900
                raise errors.BadFilenameEncoding(
 
1901
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1220
1902
            abspath = top_slash + name
1221
1903
            statvalue = _lstat(abspath)
1222
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1904
            kind = _kind_from_mode(statvalue.st_mode)
1223
1905
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1224
 
        yield (relroot, top), dirblock
1225
 
 
1226
 
        # push the user specified dirs from dirblock
1227
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1906
        return dirblock
1228
1907
 
1229
1908
 
1230
1909
def copy_tree(from_path, to_path, handlers={}):
1231
1910
    """Copy all of the entries in from_path into to_path.
1232
1911
 
1233
 
    :param from_path: The base directory to copy. 
 
1912
    :param from_path: The base directory to copy.
1234
1913
    :param to_path: The target directory. If it does not exist, it will
1235
1914
        be created.
1236
1915
    :param handlers: A dictionary of functions, which takes a source and
1269
1948
            real_handlers[kind](abspath, relpath)
1270
1949
 
1271
1950
 
 
1951
def copy_ownership_from_path(dst, src=None):
 
1952
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1953
 
 
1954
    If src is None, the containing directory is used as source. If chown
 
1955
    fails, the error is ignored and a warning is printed.
 
1956
    """
 
1957
    chown = getattr(os, 'chown', None)
 
1958
    if chown is None:
 
1959
        return
 
1960
 
 
1961
    if src == None:
 
1962
        src = os.path.dirname(dst)
 
1963
        if src == '':
 
1964
            src = '.'
 
1965
 
 
1966
    try:
 
1967
        s = os.stat(src)
 
1968
        chown(dst, s.st_uid, s.st_gid)
 
1969
    except OSError, e:
 
1970
        trace.warning(
 
1971
            'Unable to copy ownership from "%s" to "%s". '
 
1972
            'You may want to set it manually.', src, dst)
 
1973
        trace.log_exception_quietly()
 
1974
 
 
1975
 
1272
1976
def path_prefix_key(path):
1273
1977
    """Generate a prefix-order path key for path.
1274
1978
 
1287
1991
_cached_user_encoding = None
1288
1992
 
1289
1993
 
1290
 
def get_user_encoding(use_cache=True):
 
1994
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1291
1995
    """Find out what the preferred user encoding is.
1292
1996
 
1293
1997
    This is generally the encoding that is used for command line parameters
1294
1998
    and file contents. This may be different from the terminal encoding
1295
1999
    or the filesystem encoding.
1296
2000
 
1297
 
    :param  use_cache:  Enable cache for detected encoding.
1298
 
                        (This parameter is turned on by default,
1299
 
                        and required only for selftesting)
1300
 
 
1301
2001
    :return: A string defining the preferred user encoding
1302
2002
    """
1303
2003
    global _cached_user_encoding
1304
 
    if _cached_user_encoding is not None and use_cache:
 
2004
    if deprecated_passed(use_cache):
 
2005
        warn_deprecated("use_cache should only have been used for tests",
 
2006
            DeprecationWarning, stacklevel=2) 
 
2007
    if _cached_user_encoding is not None:
1305
2008
        return _cached_user_encoding
1306
2009
 
1307
 
    if sys.platform == 'darwin':
1308
 
        # work around egregious python 2.4 bug
1309
 
        sys.platform = 'posix'
1310
 
        try:
1311
 
            import locale
1312
 
        finally:
1313
 
            sys.platform = 'darwin'
 
2010
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2011
        # Use the existing locale settings and call nl_langinfo directly
 
2012
        # rather than going through getpreferredencoding. This avoids
 
2013
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2014
        # possibility of the setlocale call throwing an error.
 
2015
        user_encoding = locale.nl_langinfo(locale.CODESET)
1314
2016
    else:
1315
 
        import locale
 
2017
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2018
        user_encoding = locale.getpreferredencoding(False)
1316
2019
 
1317
2020
    try:
1318
 
        user_encoding = locale.getpreferredencoding()
1319
 
    except locale.Error, e:
1320
 
        sys.stderr.write('bzr: warning: %s\n'
1321
 
                         '  Could not determine what text encoding to use.\n'
1322
 
                         '  This error usually means your Python interpreter\n'
1323
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1324
 
                         "  Continuing with ascii encoding.\n"
1325
 
                         % (e, os.environ.get('LANG')))
1326
 
        user_encoding = 'ascii'
1327
 
 
1328
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1329
 
    # treat that as ASCII, and not support printing unicode characters to the
1330
 
    # console.
1331
 
    if user_encoding in (None, 'cp0'):
1332
 
        user_encoding = 'ascii'
1333
 
    else:
1334
 
        # check encoding
1335
 
        try:
1336
 
            codecs.lookup(user_encoding)
1337
 
        except LookupError:
 
2021
        user_encoding = codecs.lookup(user_encoding).name
 
2022
    except LookupError:
 
2023
        if user_encoding not in ("", "cp0"):
1338
2024
            sys.stderr.write('bzr: warning:'
1339
2025
                             ' unknown encoding %s.'
1340
2026
                             ' Continuing with ascii encoding.\n'
1341
2027
                             % user_encoding
1342
2028
                            )
1343
 
            user_encoding = 'ascii'
1344
 
 
1345
 
    if use_cache:
1346
 
        _cached_user_encoding = user_encoding
1347
 
 
 
2029
        user_encoding = 'ascii'
 
2030
    else:
 
2031
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2032
        if user_encoding == 'ascii':
 
2033
            if sys.platform == 'darwin':
 
2034
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2035
                # encoding and previously had LANG set here if not present.
 
2036
                user_encoding = 'utf-8'
 
2037
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2038
            #                for some other posix platforms as well.
 
2039
 
 
2040
    _cached_user_encoding = user_encoding
1348
2041
    return user_encoding
1349
2042
 
1350
2043
 
1351
 
def recv_all(socket, bytes):
 
2044
def get_diff_header_encoding():
 
2045
    return get_terminal_encoding()
 
2046
 
 
2047
 
 
2048
def get_host_name():
 
2049
    """Return the current unicode host name.
 
2050
 
 
2051
    This is meant to be used in place of socket.gethostname() because that
 
2052
    behaves inconsistently on different platforms.
 
2053
    """
 
2054
    if sys.platform == "win32":
 
2055
        return win32utils.get_host_name()
 
2056
    else:
 
2057
        import socket
 
2058
        return socket.gethostname().decode(get_user_encoding())
 
2059
 
 
2060
 
 
2061
# We must not read/write any more than 64k at a time from/to a socket so we
 
2062
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
2063
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
2064
# data at once.
 
2065
MAX_SOCKET_CHUNK = 64 * 1024
 
2066
 
 
2067
_end_of_stream_errors = [errno.ECONNRESET]
 
2068
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2069
    _eno = getattr(errno, _eno, None)
 
2070
    if _eno is not None:
 
2071
        _end_of_stream_errors.append(_eno)
 
2072
del _eno
 
2073
 
 
2074
 
 
2075
def read_bytes_from_socket(sock, report_activity=None,
 
2076
        max_read_size=MAX_SOCKET_CHUNK):
 
2077
    """Read up to max_read_size of bytes from sock and notify of progress.
 
2078
 
 
2079
    Translates "Connection reset by peer" into file-like EOF (return an
 
2080
    empty string rather than raise an error), and repeats the recv if
 
2081
    interrupted by a signal.
 
2082
    """
 
2083
    while 1:
 
2084
        try:
 
2085
            bytes = sock.recv(max_read_size)
 
2086
        except socket.error, e:
 
2087
            eno = e.args[0]
 
2088
            if eno in _end_of_stream_errors:
 
2089
                # The connection was closed by the other side.  Callers expect
 
2090
                # an empty string to signal end-of-stream.
 
2091
                return ""
 
2092
            elif eno == errno.EINTR:
 
2093
                # Retry the interrupted recv.
 
2094
                continue
 
2095
            raise
 
2096
        else:
 
2097
            if report_activity is not None:
 
2098
                report_activity(len(bytes), 'read')
 
2099
            return bytes
 
2100
 
 
2101
 
 
2102
def recv_all(socket, count):
1352
2103
    """Receive an exact number of bytes.
1353
2104
 
1354
2105
    Regular Socket.recv() may return less than the requested number of bytes,
1355
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2106
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1356
2107
    on all platforms, but this should work everywhere.  This will return
1357
2108
    less than the requested amount if the remote end closes.
1358
2109
 
1359
2110
    This isn't optimized and is intended mostly for use in testing.
1360
2111
    """
1361
2112
    b = ''
1362
 
    while len(b) < bytes:
1363
 
        new = socket.recv(bytes - len(b))
 
2113
    while len(b) < count:
 
2114
        new = read_bytes_from_socket(socket, None, count - len(b))
1364
2115
        if new == '':
1365
2116
            break # eof
1366
2117
        b += new
1367
2118
    return b
1368
2119
 
 
2120
 
 
2121
def send_all(sock, bytes, report_activity=None):
 
2122
    """Send all bytes on a socket.
 
2123
 
 
2124
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2125
    some platforms, and catches EINTR which may be thrown if the send is
 
2126
    interrupted by a signal.
 
2127
 
 
2128
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2129
    and provides activity reporting.
 
2130
 
 
2131
    :param report_activity: Call this as bytes are read, see
 
2132
        Transport._report_activity
 
2133
    """
 
2134
    sent_total = 0
 
2135
    byte_count = len(bytes)
 
2136
    while sent_total < byte_count:
 
2137
        try:
 
2138
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2139
        except socket.error, e:
 
2140
            if e.args[0] != errno.EINTR:
 
2141
                raise
 
2142
        else:
 
2143
            sent_total += sent
 
2144
            report_activity(sent, 'write')
 
2145
 
 
2146
 
 
2147
def connect_socket(address):
 
2148
    # Slight variation of the socket.create_connection() function (provided by
 
2149
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2150
    # provide it for previous python versions. Also, we don't use the timeout
 
2151
    # parameter (provided by the python implementation) so we don't implement
 
2152
    # it either).
 
2153
    err = socket.error('getaddrinfo returns an empty list')
 
2154
    host, port = address
 
2155
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2156
        af, socktype, proto, canonname, sa = res
 
2157
        sock = None
 
2158
        try:
 
2159
            sock = socket.socket(af, socktype, proto)
 
2160
            sock.connect(sa)
 
2161
            return sock
 
2162
 
 
2163
        except socket.error, err:
 
2164
            # 'err' is now the most recent error
 
2165
            if sock is not None:
 
2166
                sock.close()
 
2167
    raise err
 
2168
 
 
2169
 
1369
2170
def dereference_path(path):
1370
2171
    """Determine the real path to a file.
1371
2172
 
1383
2184
def supports_mapi():
1384
2185
    """Return True if we can use MAPI to launch a mail client."""
1385
2186
    return sys.platform == "win32"
 
2187
 
 
2188
 
 
2189
def resource_string(package, resource_name):
 
2190
    """Load a resource from a package and return it as a string.
 
2191
 
 
2192
    Note: Only packages that start with bzrlib are currently supported.
 
2193
 
 
2194
    This is designed to be a lightweight implementation of resource
 
2195
    loading in a way which is API compatible with the same API from
 
2196
    pkg_resources. See
 
2197
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
 
2198
    If and when pkg_resources becomes a standard library, this routine
 
2199
    can delegate to it.
 
2200
    """
 
2201
    # Check package name is within bzrlib
 
2202
    if package == "bzrlib":
 
2203
        resource_relpath = resource_name
 
2204
    elif package.startswith("bzrlib."):
 
2205
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2206
        resource_relpath = pathjoin(package, resource_name)
 
2207
    else:
 
2208
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2209
 
 
2210
    # Map the resource to a file and read its contents
 
2211
    base = dirname(bzrlib.__file__)
 
2212
    if getattr(sys, 'frozen', None):    # bzr.exe
 
2213
        base = abspath(pathjoin(base, '..', '..'))
 
2214
    f = file(pathjoin(base, resource_relpath), "rU")
 
2215
    try:
 
2216
        return f.read()
 
2217
    finally:
 
2218
        f.close()
 
2219
 
 
2220
def file_kind_from_stat_mode_thunk(mode):
 
2221
    global file_kind_from_stat_mode
 
2222
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
 
2223
        try:
 
2224
            from bzrlib._readdir_pyx import UTF8DirReader
 
2225
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
 
2226
        except ImportError, e:
 
2227
            # This is one time where we won't warn that an extension failed to
 
2228
            # load. The extension is never available on Windows anyway.
 
2229
            from bzrlib._readdir_py import (
 
2230
                _kind_from_mode as file_kind_from_stat_mode
 
2231
                )
 
2232
    return file_kind_from_stat_mode(mode)
 
2233
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
 
2234
 
 
2235
def file_stat(f, _lstat=os.lstat):
 
2236
    try:
 
2237
        # XXX cache?
 
2238
        return _lstat(f)
 
2239
    except OSError, e:
 
2240
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
2241
            raise errors.NoSuchFile(f)
 
2242
        raise
 
2243
 
 
2244
def file_kind(f, _lstat=os.lstat):
 
2245
    stat_value = file_stat(f, _lstat)
 
2246
    return file_kind_from_stat_mode(stat_value.st_mode)
 
2247
 
 
2248
def until_no_eintr(f, *a, **kw):
 
2249
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2250
 
 
2251
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2252
    if EINTR does occur.  This is typically only true for low-level operations
 
2253
    like os.read.  If in any doubt, don't use this.
 
2254
 
 
2255
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2256
    probably code in the Python standard library and other dependencies that
 
2257
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2258
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2259
    directly controls, but it is not a complete solution.
 
2260
    """
 
2261
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
2262
    while True:
 
2263
        try:
 
2264
            return f(*a, **kw)
 
2265
        except (IOError, OSError), e:
 
2266
            if e.errno == errno.EINTR:
 
2267
                continue
 
2268
            raise
 
2269
 
 
2270
 
 
2271
@deprecated_function(deprecated_in((2, 2, 0)))
 
2272
def re_compile_checked(re_string, flags=0, where=""):
 
2273
    """Return a compiled re, or raise a sensible error.
 
2274
 
 
2275
    This should only be used when compiling user-supplied REs.
 
2276
 
 
2277
    :param re_string: Text form of regular expression.
 
2278
    :param flags: eg re.IGNORECASE
 
2279
    :param where: Message explaining to the user the context where
 
2280
        it occurred, eg 'log search filter'.
 
2281
    """
 
2282
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2283
    try:
 
2284
        re_obj = re.compile(re_string, flags)
 
2285
        re_obj.search("")
 
2286
        return re_obj
 
2287
    except errors.InvalidPattern, e:
 
2288
        if where:
 
2289
            where = ' in ' + where
 
2290
        # despite the name 'error' is a type
 
2291
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2292
            % (where, e.msg))
 
2293
 
 
2294
 
 
2295
if sys.platform == "win32":
 
2296
    def getchar():
 
2297
        import msvcrt
 
2298
        return msvcrt.getch()
 
2299
else:
 
2300
    def getchar():
 
2301
        import tty
 
2302
        import termios
 
2303
        fd = sys.stdin.fileno()
 
2304
        settings = termios.tcgetattr(fd)
 
2305
        try:
 
2306
            tty.setraw(fd)
 
2307
            ch = sys.stdin.read(1)
 
2308
        finally:
 
2309
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
2310
        return ch
 
2311
 
 
2312
if sys.platform.startswith('linux'):
 
2313
    def _local_concurrency():
 
2314
        try:
 
2315
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2316
        except (ValueError, OSError, AttributeError):
 
2317
            return None
 
2318
elif sys.platform == 'darwin':
 
2319
    def _local_concurrency():
 
2320
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
2321
                                stdout=subprocess.PIPE).communicate()[0]
 
2322
elif "bsd" in sys.platform:
 
2323
    def _local_concurrency():
 
2324
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
2325
                                stdout=subprocess.PIPE).communicate()[0]
 
2326
elif sys.platform == 'sunos5':
 
2327
    def _local_concurrency():
 
2328
        return subprocess.Popen(['psrinfo', '-p',],
 
2329
                                stdout=subprocess.PIPE).communicate()[0]
 
2330
elif sys.platform == "win32":
 
2331
    def _local_concurrency():
 
2332
        # This appears to return the number of cores.
 
2333
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
2334
else:
 
2335
    def _local_concurrency():
 
2336
        # Who knows ?
 
2337
        return None
 
2338
 
 
2339
 
 
2340
_cached_local_concurrency = None
 
2341
 
 
2342
def local_concurrency(use_cache=True):
 
2343
    """Return how many processes can be run concurrently.
 
2344
 
 
2345
    Rely on platform specific implementations and default to 1 (one) if
 
2346
    anything goes wrong.
 
2347
    """
 
2348
    global _cached_local_concurrency
 
2349
 
 
2350
    if _cached_local_concurrency is not None and use_cache:
 
2351
        return _cached_local_concurrency
 
2352
 
 
2353
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2354
    if concurrency is None:
 
2355
        try:
 
2356
            import multiprocessing
 
2357
            concurrency = multiprocessing.cpu_count()
 
2358
        except (ImportError, NotImplementedError):
 
2359
            # multiprocessing is only available on Python >= 2.6
 
2360
            # and multiprocessing.cpu_count() isn't implemented on all
 
2361
            # platforms
 
2362
            try:
 
2363
                concurrency = _local_concurrency()
 
2364
            except (OSError, IOError):
 
2365
                pass
 
2366
    try:
 
2367
        concurrency = int(concurrency)
 
2368
    except (TypeError, ValueError):
 
2369
        concurrency = 1
 
2370
    if use_cache:
 
2371
        _cached_concurrency = concurrency
 
2372
    return concurrency
 
2373
 
 
2374
 
 
2375
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
 
2376
    """A stream writer that doesn't decode str arguments."""
 
2377
 
 
2378
    def __init__(self, encode, stream, errors='strict'):
 
2379
        codecs.StreamWriter.__init__(self, stream, errors)
 
2380
        self.encode = encode
 
2381
 
 
2382
    def write(self, object):
 
2383
        if type(object) is str:
 
2384
            self.stream.write(object)
 
2385
        else:
 
2386
            data, _ = self.encode(object, self.errors)
 
2387
            self.stream.write(data)
 
2388
 
 
2389
if sys.platform == 'win32':
 
2390
    def open_file(filename, mode='r', bufsize=-1):
 
2391
        """This function is used to override the ``open`` builtin.
 
2392
 
 
2393
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2394
        child processes.  Deleting or renaming a closed file opened with this
 
2395
        function is not blocking child processes.
 
2396
        """
 
2397
        writing = 'w' in mode
 
2398
        appending = 'a' in mode
 
2399
        updating = '+' in mode
 
2400
        binary = 'b' in mode
 
2401
 
 
2402
        flags = O_NOINHERIT
 
2403
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2404
        # for flags for each modes.
 
2405
        if binary:
 
2406
            flags |= O_BINARY
 
2407
        else:
 
2408
            flags |= O_TEXT
 
2409
 
 
2410
        if writing:
 
2411
            if updating:
 
2412
                flags |= os.O_RDWR
 
2413
            else:
 
2414
                flags |= os.O_WRONLY
 
2415
            flags |= os.O_CREAT | os.O_TRUNC
 
2416
        elif appending:
 
2417
            if updating:
 
2418
                flags |= os.O_RDWR
 
2419
            else:
 
2420
                flags |= os.O_WRONLY
 
2421
            flags |= os.O_CREAT | os.O_APPEND
 
2422
        else: #reading
 
2423
            if updating:
 
2424
                flags |= os.O_RDWR
 
2425
            else:
 
2426
                flags |= os.O_RDONLY
 
2427
 
 
2428
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2429
else:
 
2430
    open_file = open
 
2431
 
 
2432
 
 
2433
def available_backup_name(base, exists):
 
2434
    """Find a non-existing backup file name.
 
2435
 
 
2436
    This will *not* create anything, this only return a 'free' entry.  This
 
2437
    should be used for checking names in a directory below a locked
 
2438
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2439
    Leap) and generally discouraged.
 
2440
 
 
2441
    :param base: The base name.
 
2442
 
 
2443
    :param exists: A callable returning True if the path parameter exists.
 
2444
    """
 
2445
    counter = 1
 
2446
    name = "%s.~%d~" % (base, counter)
 
2447
    while exists(name):
 
2448
        counter += 1
 
2449
        name = "%s.~%d~" % (base, counter)
 
2450
    return name
 
2451
 
 
2452
 
 
2453
def set_fd_cloexec(fd):
 
2454
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2455
    support for this is not available.
 
2456
    """
 
2457
    try:
 
2458
        import fcntl
 
2459
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2460
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2461
    except (ImportError, AttributeError):
 
2462
        # Either the fcntl module or specific constants are not present
 
2463
        pass
 
2464
 
 
2465
 
 
2466
def find_executable_on_path(name):
 
2467
    """Finds an executable on the PATH.
 
2468
    
 
2469
    On Windows, this will try to append each extension in the PATHEXT
 
2470
    environment variable to the name, if it cannot be found with the name
 
2471
    as given.
 
2472
    
 
2473
    :param name: The base name of the executable.
 
2474
    :return: The path to the executable found or None.
 
2475
    """
 
2476
    if sys.platform == 'win32':
 
2477
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2478
        exts = [ext.lower() for ext in exts]
 
2479
        base, ext = os.path.splitext(name)
 
2480
        if ext != '':
 
2481
            if ext.lower() not in exts:
 
2482
                return None
 
2483
            name = base
 
2484
            exts = [ext]
 
2485
    else:
 
2486
        exts = ['']
 
2487
    path = os.environ.get('PATH')
 
2488
    if path is not None:
 
2489
        path = path.split(os.pathsep)
 
2490
        for ext in exts:
 
2491
            for d in path:
 
2492
                f = os.path.join(d, name) + ext
 
2493
                if os.access(f, os.X_OK):
 
2494
                    return f
 
2495
    if sys.platform == 'win32':
 
2496
        app_path = win32utils.get_app_path(name)
 
2497
        if app_path != name:
 
2498
            return app_path
 
2499
    return None
 
2500
 
 
2501
 
 
2502
def _posix_is_local_pid_dead(pid):
 
2503
    """True if pid doesn't correspond to live process on this machine"""
 
2504
    try:
 
2505
        # Special meaning of unix kill: just check if it's there.
 
2506
        os.kill(pid, 0)
 
2507
    except OSError, e:
 
2508
        if e.errno == errno.ESRCH:
 
2509
            # On this machine, and really not found: as sure as we can be
 
2510
            # that it's dead.
 
2511
            return True
 
2512
        elif e.errno == errno.EPERM:
 
2513
            # exists, though not ours
 
2514
            return False
 
2515
        else:
 
2516
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2517
            # Don't really know.
 
2518
            return False
 
2519
    else:
 
2520
        # Exists and our process: not dead.
 
2521
        return False
 
2522
 
 
2523
if sys.platform == "win32":
 
2524
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2525
else:
 
2526
    is_local_pid_dead = _posix_is_local_pid_dead
 
2527
 
 
2528
 
 
2529
def fdatasync(fileno):
 
2530
    """Flush file contents to disk if possible.
 
2531
    
 
2532
    :param fileno: Integer OS file handle.
 
2533
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2534
    """
 
2535
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2536
    if fn is not None:
 
2537
        fn(fileno)
 
2538
 
 
2539
 
 
2540
def ensure_empty_directory_exists(path, exception_class):
 
2541
    """Make sure a local directory exists and is empty.
 
2542
    
 
2543
    If it does not exist, it is created.  If it exists and is not empty, an
 
2544
    instance of exception_class is raised.
 
2545
    """
 
2546
    try:
 
2547
        os.mkdir(path)
 
2548
    except OSError, e:
 
2549
        if e.errno != errno.EEXIST:
 
2550
            raise
 
2551
        if os.listdir(path) != []:
 
2552
            raise exception_class(path)
 
2553
 
 
2554
 
 
2555
def is_environment_error(evalue):
 
2556
    """True if exception instance is due to a process environment issue
 
2557
 
 
2558
    This includes OSError and IOError, but also other errors that come from
 
2559
    the operating system or core libraries but are not subclasses of those.
 
2560
    """
 
2561
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2562
        return True
 
2563
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2564
        return True
 
2565
    return False