~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-13 05:47:58 UTC
  • Revision ID: mbp@sourcefrog.net-20050313054757-a86c3f5871069e22
fix up doctest for code rearrangement

Show diffs side-by-side

added added

removed removed

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