← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-05 21:25:48 UTC
  • mfrom: (3692.1.6 objectnotlocked)
  • Revision ID: pqm@pqm.ubuntu.com-20080905212548-ig8wqqpv4vb8b2v4
(spiv) Fix bug #237067 by having RemoteBranch properly lock its
        RemoteRepository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Bazaar-NG -- distributed version control
2
 
#
3
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
from cStringIO import StringIO
20
 
import errno
21
18
import os
22
 
from os import listdir
23
19
import re
24
 
import sha
25
 
import shutil
26
 
from shutil import copyfile
27
20
import stat
28
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
29
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
30
 
import string
31
23
import sys
32
24
import time
33
 
import types
34
 
import tempfile
35
 
import unicodedata
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
 
28
import codecs
 
29
from datetime import datetime
 
30
import errno
36
31
from ntpath import (abspath as _nt_abspath,
37
32
                    join as _nt_join,
38
33
                    normpath as _nt_normpath,
39
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
40
36
                    )
 
37
import posixpath
 
38
import sha
 
39
import shutil
 
40
from shutil import (
 
41
    rmtree,
 
42
    )
 
43
import tempfile
 
44
from tempfile import (
 
45
    mkdtemp,
 
46
    )
 
47
import unicodedata
 
48
 
 
49
from bzrlib import (
 
50
    cache_utf8,
 
51
    errors,
 
52
    win32utils,
 
53
    )
 
54
""")
 
55
 
41
56
 
42
57
import bzrlib
43
 
from bzrlib.errors import (BzrError,
44
 
                           BzrBadParameterNotUnicode,
45
 
                           NoSuchFile,
46
 
                           PathNotChild,
47
 
                           IllegalPath,
48
 
                           )
49
 
from bzrlib.symbol_versioning import *
 
58
from bzrlib import symbol_versioning
 
59
from bzrlib.symbol_versioning import (
 
60
    deprecated_function,
 
61
    )
50
62
from bzrlib.trace import mutter
51
 
import bzrlib.win32console
 
63
 
 
64
 
 
65
# On win32, O_BINARY is used to indicate the file should
 
66
# be opened in binary mode, rather than text mode.
 
67
# On other platforms, O_BINARY doesn't exist, because
 
68
# they always open in binary mode, so it is okay to
 
69
# OR with 0 on those platforms
 
70
O_BINARY = getattr(os, 'O_BINARY', 0)
52
71
 
53
72
 
54
73
def make_readonly(filename):
55
74
    """Make a filename read-only."""
56
 
    mod = os.stat(filename).st_mode
57
 
    mod = mod & 0777555
58
 
    os.chmod(filename, mod)
 
75
    mod = os.lstat(filename).st_mode
 
76
    if not stat.S_ISLNK(mod):
 
77
        mod = mod & 0777555
 
78
        os.chmod(filename, mod)
59
79
 
60
80
 
61
81
def make_writable(filename):
62
 
    mod = os.stat(filename).st_mode
63
 
    mod = mod | 0200
64
 
    os.chmod(filename, mod)
 
82
    mod = os.lstat(filename).st_mode
 
83
    if not stat.S_ISLNK(mod):
 
84
        mod = mod | 0200
 
85
        os.chmod(filename, mod)
 
86
 
 
87
 
 
88
def minimum_path_selection(paths):
 
89
    """Return the smallset subset of paths which are outside paths.
 
90
 
 
91
    :param paths: A container (and hence not None) of paths.
 
92
    :return: A set of paths sufficient to include everything in paths via
 
93
        is_inside_any, drawn from the paths parameter.
 
94
    """
 
95
    search_paths = set()
 
96
    paths = set(paths)
 
97
    for path in paths:
 
98
        other_paths = paths.difference([path])
 
99
        if not is_inside_any(other_paths, path):
 
100
            # this is a top level path, we must check it.
 
101
            search_paths.add(path)
 
102
    return search_paths
65
103
 
66
104
 
67
105
_QUOTE_RE = None
74
112
    Windows."""
75
113
    # TODO: I'm not really sure this is the best format either.x
76
114
    global _QUOTE_RE
77
 
    if _QUOTE_RE == None:
 
115
    if _QUOTE_RE is None:
78
116
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
79
117
        
80
118
    if _QUOTE_RE.search(f):
111
149
    try:
112
150
        return _mapper(_lstat(f).st_mode)
113
151
    except OSError, e:
114
 
        if getattr(e, 'errno', None) == errno.ENOENT:
115
 
            raise bzrlib.errors.NoSuchFile(f)
 
152
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
153
            raise errors.NoSuchFile(f)
116
154
        raise
117
155
 
118
156
 
 
157
def get_umask():
 
158
    """Return the current umask"""
 
159
    # Assume that people aren't messing with the umask while running
 
160
    # XXX: This is not thread safe, but there is no way to get the
 
161
    #      umask without setting it
 
162
    umask = os.umask(0)
 
163
    os.umask(umask)
 
164
    return umask
 
165
 
 
166
 
 
167
_kind_marker_map = {
 
168
    "file": "",
 
169
    _directory_kind: "/",
 
170
    "symlink": "@",
 
171
    'tree-reference': '+',
 
172
}
 
173
 
 
174
 
119
175
def kind_marker(kind):
120
 
    if kind == 'file':
121
 
        return ''
122
 
    elif kind == _directory_kind:
123
 
        return '/'
124
 
    elif kind == 'symlink':
125
 
        return '@'
126
 
    else:
127
 
        raise BzrError('invalid file kind %r' % kind)
 
176
    try:
 
177
        return _kind_marker_map[kind]
 
178
    except KeyError:
 
179
        raise errors.BzrError('invalid file kind %r' % kind)
 
180
 
128
181
 
129
182
lexists = getattr(os.path, 'lexists', None)
130
183
if lexists is None:
131
184
    def lexists(f):
132
185
        try:
133
 
            if hasattr(os, 'lstat'):
134
 
                os.lstat(f)
135
 
            else:
136
 
                os.stat(f)
 
186
            stat = getattr(os, 'lstat', os.stat)
 
187
            stat(f)
137
188
            return True
138
 
        except OSError,e:
 
189
        except OSError, e:
139
190
            if e.errno == errno.ENOENT:
140
191
                return False;
141
192
            else:
142
 
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
193
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
143
194
 
144
195
 
145
196
def fancy_rename(old, new, rename_func, unlink_func):
166
217
    file_existed = False
167
218
    try:
168
219
        rename_func(new, tmp_name)
169
 
    except (NoSuchFile,), e:
 
220
    except (errors.NoSuchFile,), e:
170
221
        pass
171
222
    except IOError, e:
172
223
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
173
 
        # function raises an IOError with errno == None when a rename fails.
 
224
        # function raises an IOError with errno is None when a rename fails.
174
225
        # This then gets caught here.
175
226
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
176
227
            raise
177
228
    except Exception, e:
178
 
        if (not hasattr(e, 'errno') 
 
229
        if (getattr(e, 'errno', None) is None
179
230
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
180
231
            raise
181
232
    else:
183
234
 
184
235
    success = False
185
236
    try:
186
 
        # This may throw an exception, in which case success will
187
 
        # not be set.
188
 
        rename_func(old, new)
189
 
        success = True
 
237
        try:
 
238
            # This may throw an exception, in which case success will
 
239
            # not be set.
 
240
            rename_func(old, new)
 
241
            success = True
 
242
        except (IOError, OSError), e:
 
243
            # source and target may be aliases of each other (e.g. on a
 
244
            # case-insensitive filesystem), so we may have accidentally renamed
 
245
            # source by when we tried to rename target
 
246
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
247
                raise
190
248
    finally:
191
249
        if file_existed:
192
250
            # If the file used to exist, rename it back into place
201
259
# choke on a Unicode string containing a relative path if
202
260
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
203
261
# string.
204
 
_fs_enc = sys.getfilesystemencoding()
 
262
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
205
263
def _posix_abspath(path):
206
 
    return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
207
 
    # jam 20060426 This is another possibility which mimics 
208
 
    # os.path.abspath, only uses unicode characters instead
209
 
    # if not os.path.isabs(path):
210
 
    #     return os.path.join(os.getcwdu(), path)
211
 
    # return path
 
264
    # jam 20060426 rather than encoding to fsencoding
 
265
    # copy posixpath.abspath, but use os.getcwdu instead
 
266
    if not posixpath.isabs(path):
 
267
        path = posixpath.join(getcwd(), path)
 
268
    return posixpath.normpath(path)
212
269
 
213
270
 
214
271
def _posix_realpath(path):
215
 
    return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
272
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
273
 
 
274
 
 
275
def _win32_fixdrive(path):
 
276
    """Force drive letters to be consistent.
 
277
 
 
278
    win32 is inconsistent whether it returns lower or upper case
 
279
    and even if it was consistent the user might type the other
 
280
    so we force it to uppercase
 
281
    running python.exe under cmd.exe return capital C:\\
 
282
    running win32 python inside a cygwin shell returns lowercase c:\\
 
283
    """
 
284
    drive, path = _nt_splitdrive(path)
 
285
    return drive.upper() + path
216
286
 
217
287
 
218
288
def _win32_abspath(path):
219
 
    return _nt_abspath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
 
289
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
290
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
291
 
 
292
 
 
293
def _win98_abspath(path):
 
294
    """Return the absolute version of a path.
 
295
    Windows 98 safe implementation (python reimplementation
 
296
    of Win32 API function GetFullPathNameW)
 
297
    """
 
298
    # Corner cases:
 
299
    #   C:\path     => C:/path
 
300
    #   C:/path     => C:/path
 
301
    #   \\HOST\path => //HOST/path
 
302
    #   //HOST/path => //HOST/path
 
303
    #   path        => C:/cwd/path
 
304
    #   /path       => C:/path
 
305
    path = unicode(path)
 
306
    # check for absolute path
 
307
    drive = _nt_splitdrive(path)[0]
 
308
    if drive == '' and path[:2] not in('//','\\\\'):
 
309
        cwd = os.getcwdu()
 
310
        # we cannot simply os.path.join cwd and path
 
311
        # because os.path.join('C:','/path') produce '/path'
 
312
        # and this is incorrect
 
313
        if path[:1] in ('/','\\'):
 
314
            cwd = _nt_splitdrive(cwd)[0]
 
315
            path = path[1:]
 
316
        path = cwd + '\\' + path
 
317
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
318
 
 
319
if win32utils.winver == 'Windows 98':
 
320
    _win32_abspath = _win98_abspath
220
321
 
221
322
 
222
323
def _win32_realpath(path):
223
 
    return _nt_realpath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
 
324
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
325
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
224
326
 
225
327
 
226
328
def _win32_pathjoin(*args):
228
330
 
229
331
 
230
332
def _win32_normpath(path):
231
 
    return _nt_normpath(path).replace('\\', '/')
 
333
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
232
334
 
233
335
 
234
336
def _win32_getcwd():
235
 
    return os.getcwdu().replace('\\', '/')
 
337
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
236
338
 
237
339
 
238
340
def _win32_mkdtemp(*args, **kwargs):
239
 
    return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
 
341
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
240
342
 
241
343
 
242
344
def _win32_rename(old, new):
243
 
    fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
345
    """We expect to be able to atomically replace 'new' with old.
 
346
 
 
347
    On win32, if new exists, it must be moved out of the way first,
 
348
    and then deleted. 
 
349
    """
 
350
    try:
 
351
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
352
    except OSError, e:
 
353
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
354
            # If we try to rename a non-existant file onto cwd, we get 
 
355
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
356
            # if the old path doesn't exist, sometimes we get EACCES
 
357
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
358
            os.lstat(old)
 
359
        raise
 
360
 
 
361
 
 
362
def _mac_getcwd():
 
363
    return unicodedata.normalize('NFC', os.getcwdu())
244
364
 
245
365
 
246
366
# Default is to just use the python builtins, but these can be rebound on
250
370
pathjoin = os.path.join
251
371
normpath = os.path.normpath
252
372
getcwd = os.getcwdu
253
 
mkdtemp = tempfile.mkdtemp
254
373
rename = os.rename
255
374
dirname = os.path.dirname
256
375
basename = os.path.basename
257
 
rmtree = shutil.rmtree
 
376
split = os.path.split
 
377
splitext = os.path.splitext
 
378
# These were already imported into local scope
 
379
# mkdtemp = tempfile.mkdtemp
 
380
# rmtree = shutil.rmtree
258
381
 
259
382
MIN_ABS_PATHLENGTH = 1
260
383
 
274
397
        """Error handler for shutil.rmtree function [for win32]
275
398
        Helps to remove files and dirs marked as read-only.
276
399
        """
277
 
        type_, value = excinfo[:2]
 
400
        exception = excinfo[1]
278
401
        if function in (os.remove, os.rmdir) \
279
 
            and type_ == OSError \
280
 
            and value.errno == errno.EACCES:
281
 
            bzrlib.osutils.make_writable(path)
 
402
            and isinstance(exception, OSError) \
 
403
            and exception.errno == errno.EACCES:
 
404
            make_writable(path)
282
405
            function(path)
283
406
        else:
284
407
            raise
286
409
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
287
410
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
288
411
        return shutil.rmtree(path, ignore_errors, onerror)
 
412
elif sys.platform == 'darwin':
 
413
    getcwd = _mac_getcwd
 
414
 
 
415
 
 
416
def get_terminal_encoding():
 
417
    """Find the best encoding for printing to the screen.
 
418
 
 
419
    This attempts to check both sys.stdout and sys.stdin to see
 
420
    what encoding they are in, and if that fails it falls back to
 
421
    bzrlib.user_encoding.
 
422
    The problem is that on Windows, locale.getpreferredencoding()
 
423
    is not the same encoding as that used by the console:
 
424
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
425
 
 
426
    On my standard US Windows XP, the preferred encoding is
 
427
    cp1252, but the console is cp437
 
428
    """
 
429
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
430
    if not output_encoding:
 
431
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
432
        if not input_encoding:
 
433
            output_encoding = bzrlib.user_encoding
 
434
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
435
        else:
 
436
            output_encoding = input_encoding
 
437
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
438
    else:
 
439
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
440
    if output_encoding == 'cp0':
 
441
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
442
        output_encoding = bzrlib.user_encoding
 
443
        mutter('cp0 is invalid encoding.'
 
444
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
445
    # check encoding
 
446
    try:
 
447
        codecs.lookup(output_encoding)
 
448
    except LookupError:
 
449
        sys.stderr.write('bzr: warning:'
 
450
                         ' unknown terminal encoding %s.\n'
 
451
                         '  Using encoding %s instead.\n'
 
452
                         % (output_encoding, bzrlib.user_encoding)
 
453
                        )
 
454
        output_encoding = bzrlib.user_encoding
 
455
 
 
456
    return output_encoding
289
457
 
290
458
 
291
459
def normalizepath(f):
292
 
    if hasattr(os.path, 'realpath'):
 
460
    if getattr(os.path, 'realpath', None) is not None:
293
461
        F = realpath
294
462
    else:
295
463
        F = abspath
300
468
        return pathjoin(F(p), e)
301
469
 
302
470
 
303
 
def backup_file(fn):
304
 
    """Copy a file to a backup.
305
 
 
306
 
    Backups are named in GNU-style, with a ~ suffix.
307
 
 
308
 
    If the file is already a backup, it's not copied.
309
 
    """
310
 
    if fn[-1] == '~':
311
 
        return
312
 
    bfn = fn + '~'
313
 
 
314
 
    if has_symlinks() and os.path.islink(fn):
315
 
        target = os.readlink(fn)
316
 
        os.symlink(target, bfn)
317
 
        return
318
 
    inf = file(fn, 'rb')
319
 
    try:
320
 
        content = inf.read()
321
 
    finally:
322
 
        inf.close()
323
 
    
324
 
    outf = file(bfn, 'wb')
325
 
    try:
326
 
        outf.write(content)
327
 
    finally:
328
 
        outf.close()
329
 
 
330
 
 
331
471
def isdir(f):
332
472
    """True if f is an accessible directory."""
333
473
    try:
359
499
    
360
500
    The empty string as a dir name is taken as top-of-tree and matches 
361
501
    everything.
362
 
    
363
 
    >>> is_inside('src', pathjoin('src', 'foo.c'))
364
 
    True
365
 
    >>> is_inside('src', 'srccontrol')
366
 
    False
367
 
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
368
 
    True
369
 
    >>> is_inside('foo.c', 'foo.c')
370
 
    True
371
 
    >>> is_inside('foo.c', '')
372
 
    False
373
 
    >>> is_inside('', 'foo.c')
374
 
    True
375
502
    """
376
503
    # XXX: Most callers of this can actually do something smarter by 
377
504
    # looking at the inventory
392
519
    for dirname in dir_list:
393
520
        if is_inside(dirname, fname):
394
521
            return True
395
 
    else:
396
 
        return False
 
522
    return False
397
523
 
398
524
 
399
525
def is_inside_or_parent_of_any(dir_list, fname):
401
527
    for dirname in dir_list:
402
528
        if is_inside(dirname, fname) or is_inside(fname, dirname):
403
529
            return True
 
530
    return False
 
531
 
 
532
 
 
533
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
 
534
    """Copy contents of one file to another.
 
535
 
 
536
    The read_length can either be -1 to read to end-of-file (EOF) or
 
537
    it can specify the maximum number of bytes to read.
 
538
 
 
539
    The buff_size represents the maximum size for each read operation
 
540
    performed on from_file.
 
541
 
 
542
    :return: The number of bytes copied.
 
543
    """
 
544
    length = 0
 
545
    if read_length >= 0:
 
546
        # read specified number of bytes
 
547
 
 
548
        while read_length > 0:
 
549
            num_bytes_to_read = min(read_length, buff_size)
 
550
 
 
551
            block = from_file.read(num_bytes_to_read)
 
552
            if not block:
 
553
                # EOF reached
 
554
                break
 
555
            to_file.write(block)
 
556
 
 
557
            actual_bytes_read = len(block)
 
558
            read_length -= actual_bytes_read
 
559
            length += actual_bytes_read
404
560
    else:
405
 
        return False
406
 
 
407
 
 
408
 
def pumpfile(fromfile, tofile):
409
 
    """Copy contents of one file to another."""
410
 
    BUFSIZE = 32768
411
 
    while True:
412
 
        b = fromfile.read(BUFSIZE)
413
 
        if not b:
414
 
            break
415
 
        tofile.write(b)
 
561
        # read to EOF
 
562
        while True:
 
563
            block = from_file.read(buff_size)
 
564
            if not block:
 
565
                # EOF reached
 
566
                break
 
567
            to_file.write(block)
 
568
            length += len(block)
 
569
    return length
 
570
 
 
571
 
 
572
def pump_string_file(bytes, file_handle, segment_size=None):
 
573
    """Write bytes to file_handle in many smaller writes.
 
574
 
 
575
    :param bytes: The string to write.
 
576
    :param file_handle: The file to write to.
 
577
    """
 
578
    # Write data in chunks rather than all at once, because very large
 
579
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
580
    # drives).
 
581
    if not segment_size:
 
582
        segment_size = 5242880 # 5MB
 
583
    segments = range(len(bytes) / segment_size + 1)
 
584
    write = file_handle.write
 
585
    for segment_index in segments:
 
586
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
587
        write(segment)
416
588
 
417
589
 
418
590
def file_iterator(input_file, readsize=32768):
424
596
 
425
597
 
426
598
def sha_file(f):
427
 
    if hasattr(f, 'tell'):
428
 
        assert f.tell() == 0
 
599
    """Calculate the hexdigest of an open file.
 
600
 
 
601
    The file cursor should be already at the start.
 
602
    """
429
603
    s = sha.new()
430
604
    BUFSIZE = 128<<10
431
605
    while True:
436
610
    return s.hexdigest()
437
611
 
438
612
 
439
 
 
440
 
def sha_strings(strings):
 
613
def sha_file_by_name(fname):
 
614
    """Calculate the SHA1 of a file by reading the full text"""
 
615
    s = sha.new()
 
616
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
617
    try:
 
618
        while True:
 
619
            b = os.read(f, 1<<16)
 
620
            if not b:
 
621
                return s.hexdigest()
 
622
            s.update(b)
 
623
    finally:
 
624
        os.close(f)
 
625
 
 
626
 
 
627
def sha_strings(strings, _factory=sha.new):
441
628
    """Return the sha-1 of concatenation of strings"""
442
 
    s = sha.new()
 
629
    s = _factory()
443
630
    map(s.update, strings)
444
631
    return s.hexdigest()
445
632
 
446
633
 
447
 
def sha_string(f):
448
 
    s = sha.new()
449
 
    s.update(f)
450
 
    return s.hexdigest()
 
634
def sha_string(f, _factory=sha.new):
 
635
    return _factory(f).hexdigest()
451
636
 
452
637
 
453
638
def fingerprint_file(f):
454
 
    s = sha.new()
455
639
    b = f.read()
456
 
    s.update(b)
457
 
    size = len(b)
458
 
    return {'size': size,
459
 
            'sha1': s.hexdigest()}
 
640
    return {'size': len(b),
 
641
            'sha1': sha.new(b).hexdigest()}
460
642
 
461
643
 
462
644
def compare_files(a, b):
473
655
 
474
656
def local_time_offset(t=None):
475
657
    """Return offset of local zone from GMT, either at present or at time t."""
476
 
    # python2.3 localtime() can't take None
477
 
    if t == None:
 
658
    if t is None:
478
659
        t = time.time()
479
 
        
480
 
    if time.localtime(t).tm_isdst and time.daylight:
481
 
        return -time.altzone
482
 
    else:
483
 
        return -time.timezone
 
660
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
661
    return offset.days * 86400 + offset.seconds
484
662
 
 
663
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
485
664
    
486
 
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
665
def format_date(t, offset=0, timezone='original', date_fmt=None,
487
666
                show_offset=True):
488
 
    ## TODO: Perhaps a global option to use either universal or local time?
489
 
    ## Or perhaps just let people set $TZ?
490
 
    assert isinstance(t, float)
491
 
    
 
667
    """Return a formatted date string.
 
668
 
 
669
    :param t: Seconds since the epoch.
 
670
    :param offset: Timezone offset in seconds east of utc.
 
671
    :param timezone: How to display the time: 'utc', 'original' for the
 
672
         timezone specified by offset, or 'local' for the process's current
 
673
         timezone.
 
674
    :param show_offset: Whether to append the timezone.
 
675
    :param date_fmt: strftime format.
 
676
    """
492
677
    if timezone == 'utc':
493
678
        tt = time.gmtime(t)
494
679
        offset = 0
495
680
    elif timezone == 'original':
496
 
        if offset == None:
 
681
        if offset is None:
497
682
            offset = 0
498
683
        tt = time.gmtime(t + offset)
499
684
    elif timezone == 'local':
500
685
        tt = time.localtime(t)
501
686
        offset = local_time_offset(t)
502
687
    else:
503
 
        raise BzrError("unsupported timezone format %r" % timezone,
504
 
                       ['options are "utc", "original", "local"'])
 
688
        raise errors.UnsupportedTimezoneFormat(timezone)
505
689
    if date_fmt is None:
506
690
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
507
691
    if show_offset:
508
692
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
509
693
    else:
510
694
        offset_str = ''
 
695
    # day of week depends on locale, so we do this ourself
 
696
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
511
697
    return (time.strftime(date_fmt, tt) +  offset_str)
512
698
 
513
699
 
515
701
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
516
702
    
517
703
 
 
704
def format_delta(delta):
 
705
    """Get a nice looking string for a time delta.
 
706
 
 
707
    :param delta: The time difference in seconds, can be positive or negative.
 
708
        positive indicates time in the past, negative indicates time in the
 
709
        future. (usually time.time() - stored_time)
 
710
    :return: String formatted to show approximate resolution
 
711
    """
 
712
    delta = int(delta)
 
713
    if delta >= 0:
 
714
        direction = 'ago'
 
715
    else:
 
716
        direction = 'in the future'
 
717
        delta = -delta
 
718
 
 
719
    seconds = delta
 
720
    if seconds < 90: # print seconds up to 90 seconds
 
721
        if seconds == 1:
 
722
            return '%d second %s' % (seconds, direction,)
 
723
        else:
 
724
            return '%d seconds %s' % (seconds, direction)
 
725
 
 
726
    minutes = int(seconds / 60)
 
727
    seconds -= 60 * minutes
 
728
    if seconds == 1:
 
729
        plural_seconds = ''
 
730
    else:
 
731
        plural_seconds = 's'
 
732
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
733
        if minutes == 1:
 
734
            return '%d minute, %d second%s %s' % (
 
735
                    minutes, seconds, plural_seconds, direction)
 
736
        else:
 
737
            return '%d minutes, %d second%s %s' % (
 
738
                    minutes, seconds, plural_seconds, direction)
 
739
 
 
740
    hours = int(minutes / 60)
 
741
    minutes -= 60 * hours
 
742
    if minutes == 1:
 
743
        plural_minutes = ''
 
744
    else:
 
745
        plural_minutes = 's'
 
746
 
 
747
    if hours == 1:
 
748
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
749
                                            plural_minutes, direction)
 
750
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
751
                                         plural_minutes, direction)
518
752
 
519
753
def filesize(f):
520
754
    """Return size of given open file."""
530
764
except (NotImplementedError, AttributeError):
531
765
    # If python doesn't have os.urandom, or it doesn't work,
532
766
    # then try to first pull random data from /dev/urandom
533
 
    if os.path.exists("/dev/urandom"):
 
767
    try:
534
768
        rand_bytes = file('/dev/urandom', 'rb').read
535
769
    # Otherwise, use this hack as a last resort
536
 
    else:
 
770
    except (IOError, OSError):
537
771
        # not well seeded, but better than nothing
538
772
        def rand_bytes(n):
539
773
            import random
561
795
## decomposition (might be too tricksy though.)
562
796
 
563
797
def splitpath(p):
564
 
    """Turn string into list of parts.
565
 
 
566
 
    >>> splitpath('a')
567
 
    ['a']
568
 
    >>> splitpath('a/b')
569
 
    ['a', 'b']
570
 
    >>> splitpath('a/./b')
571
 
    ['a', 'b']
572
 
    >>> splitpath('a/.b')
573
 
    ['a', '.b']
574
 
    >>> splitpath('a/../b')
575
 
    Traceback (most recent call last):
576
 
    ...
577
 
    BzrError: sorry, '..' not allowed in path
578
 
    """
579
 
    assert isinstance(p, types.StringTypes)
580
 
 
 
798
    """Turn string into list of parts."""
581
799
    # split on either delimiter because people might use either on
582
800
    # Windows
583
801
    ps = re.split(r'[\\/]', p)
585
803
    rps = []
586
804
    for f in ps:
587
805
        if f == '..':
588
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
806
            raise errors.BzrError("sorry, %r not allowed in path" % f)
589
807
        elif (f == '.') or (f == ''):
590
808
            pass
591
809
        else:
593
811
    return rps
594
812
 
595
813
def joinpath(p):
596
 
    assert isinstance(p, list)
597
814
    for f in p:
598
 
        if (f == '..') or (f == None) or (f == ''):
599
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
815
        if (f == '..') or (f is None) or (f == ''):
 
816
            raise errors.BzrError("sorry, %r not allowed in path" % f)
600
817
    return pathjoin(*p)
601
818
 
602
819
 
603
 
@deprecated_function(zero_nine)
604
 
def appendpath(p1, p2):
605
 
    if p1 == '':
606
 
        return p2
607
 
    else:
608
 
        return pathjoin(p1, p2)
609
 
    
610
 
 
611
820
def split_lines(s):
612
821
    """Split s into lines, but without removing the newline characters."""
613
822
    lines = s.split('\n')
624
833
def link_or_copy(src, dest):
625
834
    """Hardlink a file, or copy it if it can't be hardlinked."""
626
835
    if not hardlinks_good():
627
 
        copyfile(src, dest)
 
836
        shutil.copyfile(src, dest)
628
837
        return
629
838
    try:
630
839
        os.link(src, dest)
631
840
    except (OSError, IOError), e:
632
841
        if e.errno != errno.EXDEV:
633
842
            raise
634
 
        copyfile(src, dest)
635
 
 
636
 
def delete_any(full_path):
 
843
        shutil.copyfile(src, dest)
 
844
 
 
845
 
 
846
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
847
# Forgiveness than Permission (EAFP) because:
 
848
# - root can damage a solaris file system by using unlink,
 
849
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
850
#   EACCES, OSX: EPERM) when invoked on a directory.
 
851
def delete_any(path):
637
852
    """Delete a file or directory."""
638
 
    try:
639
 
        os.unlink(full_path)
640
 
    except OSError, e:
641
 
    # We may be renaming a dangling inventory id
642
 
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
643
 
            raise
644
 
        os.rmdir(full_path)
 
853
    if isdir(path): # Takes care of symlinks
 
854
        os.rmdir(path)
 
855
    else:
 
856
        os.unlink(path)
645
857
 
646
858
 
647
859
def has_symlinks():
648
 
    if hasattr(os, 'symlink'):
649
 
        return True
650
 
    else:
651
 
        return False
652
 
        
 
860
    if getattr(os, 'symlink', None) is not None:
 
861
        return True
 
862
    else:
 
863
        return False
 
864
 
 
865
 
 
866
def has_hardlinks():
 
867
    if getattr(os, 'link', None) is not None:
 
868
        return True
 
869
    else:
 
870
        return False
 
871
 
 
872
 
 
873
def host_os_dereferences_symlinks():
 
874
    return (has_symlinks()
 
875
            and sys.platform not in ('cygwin', 'win32'))
 
876
 
653
877
 
654
878
def contains_whitespace(s):
655
879
    """True if there are any whitespace characters in s."""
656
 
    for ch in string.whitespace:
 
880
    # string.whitespace can include '\xa0' in certain locales, because it is
 
881
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
882
    # 1) Isn't a breaking whitespace
 
883
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
884
    #    separators
 
885
    # 3) '\xa0' isn't unicode safe since it is >128.
 
886
 
 
887
    # This should *not* be a unicode set of characters in case the source
 
888
    # string is not a Unicode string. We can auto-up-cast the characters since
 
889
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
890
    # is utf-8
 
891
    for ch in ' \t\n\r\v\f':
657
892
        if ch in s:
658
893
            return True
659
894
    else:
680
915
    avoids that problem.
681
916
    """
682
917
 
683
 
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
684
 
        ' exceed the platform minimum length (which is %d)' % 
685
 
        MIN_ABS_PATHLENGTH)
 
918
    if len(base) < MIN_ABS_PATHLENGTH:
 
919
        # must have space for e.g. a drive letter
 
920
        raise ValueError('%r is too short to calculate a relative path'
 
921
            % (base,))
686
922
 
687
923
    rp = abspath(path)
688
924
 
695
931
        if tail:
696
932
            s.insert(0, tail)
697
933
    else:
698
 
        raise PathNotChild(rp, base)
 
934
        raise errors.PathNotChild(rp, base)
699
935
 
700
936
    if s:
701
937
        return pathjoin(*s)
716
952
    try:
717
953
        return unicode_or_utf8_string.decode('utf8')
718
954
    except UnicodeDecodeError:
719
 
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
955
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
956
 
 
957
 
 
958
def safe_utf8(unicode_or_utf8_string):
 
959
    """Coerce unicode_or_utf8_string to a utf8 string.
 
960
 
 
961
    If it is a str, it is returned.
 
962
    If it is Unicode, it is encoded into a utf-8 string.
 
963
    """
 
964
    if isinstance(unicode_or_utf8_string, str):
 
965
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
966
        #       performance if we are dealing with lots of apis that want a
 
967
        #       utf-8 revision id
 
968
        try:
 
969
            # Make sure it is a valid utf-8 string
 
970
            unicode_or_utf8_string.decode('utf-8')
 
971
        except UnicodeDecodeError:
 
972
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
973
        return unicode_or_utf8_string
 
974
    return unicode_or_utf8_string.encode('utf-8')
 
975
 
 
976
 
 
977
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
978
                        ' Revision id generators should be creating utf8'
 
979
                        ' revision ids.')
 
980
 
 
981
 
 
982
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
983
    """Revision ids should now be utf8, but at one point they were unicode.
 
984
 
 
985
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
986
        utf8 or None).
 
987
    :param warn: Functions that are sanitizing user data can set warn=False
 
988
    :return: None or a utf8 revision id.
 
989
    """
 
990
    if (unicode_or_utf8_string is None
 
991
        or unicode_or_utf8_string.__class__ == str):
 
992
        return unicode_or_utf8_string
 
993
    if warn:
 
994
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
995
                               stacklevel=2)
 
996
    return cache_utf8.encode(unicode_or_utf8_string)
 
997
 
 
998
 
 
999
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1000
                    ' generators should be creating utf8 file ids.')
 
1001
 
 
1002
 
 
1003
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1004
    """File ids should now be utf8, but at one point they were unicode.
 
1005
 
 
1006
    This is the same as safe_utf8, except it uses the cached encode functions
 
1007
    to save a little bit of performance.
 
1008
 
 
1009
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
1010
        utf8 or None).
 
1011
    :param warn: Functions that are sanitizing user data can set warn=False
 
1012
    :return: None or a utf8 file id.
 
1013
    """
 
1014
    if (unicode_or_utf8_string is None
 
1015
        or unicode_or_utf8_string.__class__ == str):
 
1016
        return unicode_or_utf8_string
 
1017
    if warn:
 
1018
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1019
                               stacklevel=2)
 
1020
    return cache_utf8.encode(unicode_or_utf8_string)
720
1021
 
721
1022
 
722
1023
_platform_normalizes_filenames = False
732
1033
    return _platform_normalizes_filenames
733
1034
 
734
1035
 
 
1036
def _accessible_normalized_filename(path):
 
1037
    """Get the unicode normalized path, and if you can access the file.
 
1038
 
 
1039
    On platforms where the system normalizes filenames (Mac OSX),
 
1040
    you can access a file by any path which will normalize correctly.
 
1041
    On platforms where the system does not normalize filenames 
 
1042
    (Windows, Linux), you have to access a file by its exact path.
 
1043
 
 
1044
    Internally, bzr only supports NFC normalization, since that is 
 
1045
    the standard for XML documents.
 
1046
 
 
1047
    So return the normalized path, and a flag indicating if the file
 
1048
    can be accessed by that path.
 
1049
    """
 
1050
 
 
1051
    return unicodedata.normalize('NFC', unicode(path)), True
 
1052
 
 
1053
 
 
1054
def _inaccessible_normalized_filename(path):
 
1055
    __doc__ = _accessible_normalized_filename.__doc__
 
1056
 
 
1057
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1058
    return normalized, normalized == path
 
1059
 
 
1060
 
735
1061
if _platform_normalizes_filenames:
736
 
    def unicode_filename(path):
737
 
        """Make sure 'path' is a properly normalized filename.
738
 
 
739
 
        On platforms where the system normalizes filenames (Mac OSX),
740
 
        you can access a file by any path which will normalize
741
 
        correctly.
742
 
        Internally, bzr only supports NFC/NFKC normalization, since
743
 
        that is the standard for XML documents.
744
 
        So we return an normalized path, and indicate this has been
745
 
        properly normalized.
746
 
 
747
 
        :return: (path, is_normalized) Return a path which can
748
 
                access the file, and whether or not this path is
749
 
                normalized.
750
 
        """
751
 
        return unicodedata.normalize('NFKC', path), True
 
1062
    normalized_filename = _accessible_normalized_filename
752
1063
else:
753
 
    def unicode_filename(path):
754
 
        """Make sure 'path' is a properly normalized filename.
755
 
 
756
 
        On platforms where the system does not normalize filenames 
757
 
        (Windows, Linux), you have to access a file by its exact path.
758
 
        Internally, bzr only supports NFC/NFKC normalization, since
759
 
        that is the standard for XML documents.
760
 
        So we return the original path, and indicate if this is
761
 
        properly normalized.
762
 
 
763
 
        :return: (path, is_normalized) Return a path which can
764
 
                access the file, and whether or not this path is
765
 
                normalized.
766
 
        """
767
 
        return path, unicodedata.normalize('NFKC', path) == path
 
1064
    normalized_filename = _inaccessible_normalized_filename
768
1065
 
769
1066
 
770
1067
def terminal_width():
771
1068
    """Return estimated terminal width."""
772
1069
    if sys.platform == 'win32':
773
 
        import bzrlib.win32console
774
 
        return bzrlib.win32console.get_console_size()[0]
 
1070
        return win32utils.get_console_size()[0]
775
1071
    width = 0
776
1072
    try:
777
1073
        import struct, fcntl, termios
790
1086
 
791
1087
    return width
792
1088
 
 
1089
 
793
1090
def supports_executable():
794
1091
    return sys.platform != "win32"
795
1092
 
796
1093
 
 
1094
def supports_posix_readonly():
 
1095
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1096
 
 
1097
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1098
    directory controls creation/deletion, etc.
 
1099
 
 
1100
    And under win32, readonly means that the directory itself cannot be
 
1101
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1102
    where files in readonly directories cannot be added, deleted or renamed.
 
1103
    """
 
1104
    return sys.platform != "win32"
 
1105
 
 
1106
 
 
1107
def set_or_unset_env(env_variable, value):
 
1108
    """Modify the environment, setting or removing the env_variable.
 
1109
 
 
1110
    :param env_variable: The environment variable in question
 
1111
    :param value: The value to set the environment to. If None, then
 
1112
        the variable will be removed.
 
1113
    :return: The original value of the environment variable.
 
1114
    """
 
1115
    orig_val = os.environ.get(env_variable)
 
1116
    if value is None:
 
1117
        if orig_val is not None:
 
1118
            del os.environ[env_variable]
 
1119
    else:
 
1120
        if isinstance(value, unicode):
 
1121
            value = value.encode(bzrlib.user_encoding)
 
1122
        os.environ[env_variable] = value
 
1123
    return orig_val
 
1124
 
 
1125
 
797
1126
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
798
1127
 
799
1128
 
805
1134
    if sys.platform != "win32":
806
1135
        return
807
1136
    if _validWin32PathRE.match(path) is None:
808
 
        raise IllegalPath(path)
 
1137
        raise errors.IllegalPath(path)
 
1138
 
 
1139
 
 
1140
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1141
 
 
1142
def _is_error_enotdir(e):
 
1143
    """Check if this exception represents ENOTDIR.
 
1144
 
 
1145
    Unfortunately, python is very inconsistent about the exception
 
1146
    here. The cases are:
 
1147
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1148
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1149
         which is the windows error code.
 
1150
      3) Windows, Python2.5 uses errno == EINVAL and
 
1151
         winerror == ERROR_DIRECTORY
 
1152
 
 
1153
    :param e: An Exception object (expected to be OSError with an errno
 
1154
        attribute, but we should be able to cope with anything)
 
1155
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1156
    """
 
1157
    en = getattr(e, 'errno', None)
 
1158
    if (en == errno.ENOTDIR
 
1159
        or (sys.platform == 'win32'
 
1160
            and (en == _WIN32_ERROR_DIRECTORY
 
1161
                 or (en == errno.EINVAL
 
1162
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1163
        ))):
 
1164
        return True
 
1165
    return False
809
1166
 
810
1167
 
811
1168
def walkdirs(top, prefix=""):
816
1173
    to exclude some directories, they are then not descended into.
817
1174
    
818
1175
    The data yielded is of the form:
819
 
    [(relpath, basename, kind, lstat, path_from_top), ...]
 
1176
    ((directory-relpath, directory-path-from-top),
 
1177
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
1178
     - directory-relpath is the relative path of the directory being returned
 
1179
       with respect to top. prefix is prepended to this.
 
1180
     - directory-path-from-root is the path including top for this directory. 
 
1181
       It is suitable for use with os functions.
 
1182
     - relpath is the relative path within the subtree being walked.
 
1183
     - basename is the basename of the path
 
1184
     - kind is the kind of the file now. If unknown then the file is not
 
1185
       present within the tree - but it may be recorded as versioned. See
 
1186
       versioned_kind.
 
1187
     - lstat is the stat data *if* the file was statted.
 
1188
     - planned, not implemented: 
 
1189
       path_from_tree_root is the path from the root of the tree.
820
1190
 
821
1191
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
822
1192
        allows one to walk a subtree but get paths that are relative to a tree
823
1193
        rooted higher up.
824
1194
    :return: an iterator over the dirs.
825
1195
    """
826
 
    lstat = os.lstat
827
 
    pending = []
 
1196
    #TODO there is a bit of a smell where the results of the directory-
 
1197
    # summary in this, and the path from the root, may not agree 
 
1198
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
1199
    # potentially confusing output. We should make this more robust - but
 
1200
    # not at a speed cost. RBC 20060731
 
1201
    _lstat = os.lstat
828
1202
    _directory = _directory_kind
829
 
    _listdir = listdir
830
 
    pending = [(prefix, "", _directory, None, top)]
 
1203
    _listdir = os.listdir
 
1204
    _kind_from_mode = _formats.get
 
1205
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
831
1206
    while pending:
832
 
        dirblock = []
833
 
        currentdir = pending.pop()
834
1207
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
835
 
        top = currentdir[4]
836
 
        if currentdir[0]:
837
 
            relroot = currentdir[0] + '/'
838
 
        else:
839
 
            relroot = ""
 
1208
        relroot, _, _, _, top = pending.pop()
 
1209
        if relroot:
 
1210
            relprefix = relroot + u'/'
 
1211
        else:
 
1212
            relprefix = ''
 
1213
        top_slash = top + u'/'
 
1214
 
 
1215
        dirblock = []
 
1216
        append = dirblock.append
 
1217
        try:
 
1218
            names = sorted(_listdir(top))
 
1219
        except OSError, e:
 
1220
            if not _is_error_enotdir(e):
 
1221
                raise
 
1222
        else:
 
1223
            for name in names:
 
1224
                abspath = top_slash + name
 
1225
                statvalue = _lstat(abspath)
 
1226
                kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1227
                append((relprefix + name, name, kind, statvalue, abspath))
 
1228
        yield (relroot, top), dirblock
 
1229
 
 
1230
        # push the user specified dirs from dirblock
 
1231
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1232
 
 
1233
 
 
1234
_real_walkdirs_utf8 = None
 
1235
 
 
1236
def _walkdirs_utf8(top, prefix=""):
 
1237
    """Yield data about all the directories in a tree.
 
1238
 
 
1239
    This yields the same information as walkdirs() only each entry is yielded
 
1240
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1241
    are returned as exact byte-strings.
 
1242
 
 
1243
    :return: yields a tuple of (dir_info, [file_info])
 
1244
        dir_info is (utf8_relpath, path-from-top)
 
1245
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1246
        if top is an absolute path, path-from-top is also an absolute path.
 
1247
        path-from-top might be unicode or utf8, but it is the correct path to
 
1248
        pass to os functions to affect the file in question. (such as os.lstat)
 
1249
    """
 
1250
    global _real_walkdirs_utf8
 
1251
    if _real_walkdirs_utf8 is None:
 
1252
        fs_encoding = _fs_enc.upper()
 
1253
        if win32utils.winver == 'Windows NT':
 
1254
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1255
            # TODO: We possibly could support Win98 by falling back to the
 
1256
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1257
            #       but that gets a bit tricky, and requires custom compiling
 
1258
            #       for win98 anyway.
 
1259
            try:
 
1260
                from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
 
1261
            except ImportError:
 
1262
                _real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
 
1263
            else:
 
1264
                _real_walkdirs_utf8 = _walkdirs_utf8_win32_find_file
 
1265
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1266
            # ANSI_X3.4-1968 is a form of ASCII
 
1267
            _real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
 
1268
        else:
 
1269
            _real_walkdirs_utf8 = _walkdirs_fs_utf8
 
1270
    return _real_walkdirs_utf8(top, prefix=prefix)
 
1271
 
 
1272
 
 
1273
def _walkdirs_fs_utf8(top, prefix=""):
 
1274
    """See _walkdirs_utf8.
 
1275
 
 
1276
    This sub-function is called when we know the filesystem is already in utf8
 
1277
    encoding. So we don't need to transcode filenames.
 
1278
    """
 
1279
    _lstat = os.lstat
 
1280
    _directory = _directory_kind
 
1281
    # Use C accelerated directory listing.
 
1282
    _listdir = _read_dir
 
1283
    _kind_from_mode = _formats.get
 
1284
 
 
1285
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1286
    # But we don't actually uses 1-3 in pending, so set them to None
 
1287
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1288
    while pending:
 
1289
        relroot, _, _, _, top = pending.pop()
 
1290
        if relroot:
 
1291
            relprefix = relroot + '/'
 
1292
        else:
 
1293
            relprefix = ''
 
1294
        top_slash = top + '/'
 
1295
 
 
1296
        dirblock = []
 
1297
        append = dirblock.append
 
1298
        # read_dir supplies in should-stat order.
 
1299
        for _, name in sorted(_listdir(top)):
 
1300
            abspath = top_slash + name
 
1301
            statvalue = _lstat(abspath)
 
1302
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1303
            append((relprefix + name, name, kind, statvalue, abspath))
 
1304
        dirblock.sort()
 
1305
        yield (relroot, top), dirblock
 
1306
 
 
1307
        # push the user specified dirs from dirblock
 
1308
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1309
 
 
1310
 
 
1311
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1312
    """See _walkdirs_utf8
 
1313
 
 
1314
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1315
    Unicode paths.
 
1316
    This is currently the fallback code path when the filesystem encoding is
 
1317
    not UTF-8. It may be better to implement an alternative so that we can
 
1318
    safely handle paths that are not properly decodable in the current
 
1319
    encoding.
 
1320
    """
 
1321
    _utf8_encode = codecs.getencoder('utf8')
 
1322
    _lstat = os.lstat
 
1323
    _directory = _directory_kind
 
1324
    _listdir = os.listdir
 
1325
    _kind_from_mode = _formats.get
 
1326
 
 
1327
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1328
    while pending:
 
1329
        relroot, _, _, _, top = pending.pop()
 
1330
        if relroot:
 
1331
            relprefix = relroot + '/'
 
1332
        else:
 
1333
            relprefix = ''
 
1334
        top_slash = top + u'/'
 
1335
 
 
1336
        dirblock = []
 
1337
        append = dirblock.append
840
1338
        for name in sorted(_listdir(top)):
841
 
            abspath = top + '/' + name
842
 
            statvalue = lstat(abspath)
843
 
            dirblock.append ((relroot + name, name, file_kind_from_stat_mode(statvalue.st_mode), statvalue, abspath))
844
 
        yield dirblock
 
1339
            name_utf8 = _utf8_encode(name)[0]
 
1340
            abspath = top_slash + name
 
1341
            statvalue = _lstat(abspath)
 
1342
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1343
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1344
        yield (relroot, top), dirblock
 
1345
 
845
1346
        # push the user specified dirs from dirblock
846
 
        for dir in reversed(dirblock):
847
 
            if dir[2] == _directory:
848
 
                pending.append(dir)
 
1347
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1348
 
 
1349
 
 
1350
def copy_tree(from_path, to_path, handlers={}):
 
1351
    """Copy all of the entries in from_path into to_path.
 
1352
 
 
1353
    :param from_path: The base directory to copy. 
 
1354
    :param to_path: The target directory. If it does not exist, it will
 
1355
        be created.
 
1356
    :param handlers: A dictionary of functions, which takes a source and
 
1357
        destinations for files, directories, etc.
 
1358
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1359
        'file', 'directory', and 'symlink' should always exist.
 
1360
        If they are missing, they will be replaced with 'os.mkdir()',
 
1361
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1362
    """
 
1363
    # Now, just copy the existing cached tree to the new location
 
1364
    # We use a cheap trick here.
 
1365
    # Absolute paths are prefixed with the first parameter
 
1366
    # relative paths are prefixed with the second.
 
1367
    # So we can get both the source and target returned
 
1368
    # without any extra work.
 
1369
 
 
1370
    def copy_dir(source, dest):
 
1371
        os.mkdir(dest)
 
1372
 
 
1373
    def copy_link(source, dest):
 
1374
        """Copy the contents of a symlink"""
 
1375
        link_to = os.readlink(source)
 
1376
        os.symlink(link_to, dest)
 
1377
 
 
1378
    real_handlers = {'file':shutil.copy2,
 
1379
                     'symlink':copy_link,
 
1380
                     'directory':copy_dir,
 
1381
                    }
 
1382
    real_handlers.update(handlers)
 
1383
 
 
1384
    if not os.path.exists(to_path):
 
1385
        real_handlers['directory'](from_path, to_path)
 
1386
 
 
1387
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1388
        for relpath, name, kind, st, abspath in entries:
 
1389
            real_handlers[kind](abspath, relpath)
 
1390
 
 
1391
 
 
1392
def path_prefix_key(path):
 
1393
    """Generate a prefix-order path key for path.
 
1394
 
 
1395
    This can be used to sort paths in the same way that walkdirs does.
 
1396
    """
 
1397
    return (dirname(path) , path)
 
1398
 
 
1399
 
 
1400
def compare_paths_prefix_order(path_a, path_b):
 
1401
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1402
    key_a = path_prefix_key(path_a)
 
1403
    key_b = path_prefix_key(path_b)
 
1404
    return cmp(key_a, key_b)
 
1405
 
 
1406
 
 
1407
_cached_user_encoding = None
 
1408
 
 
1409
 
 
1410
def get_user_encoding(use_cache=True):
 
1411
    """Find out what the preferred user encoding is.
 
1412
 
 
1413
    This is generally the encoding that is used for command line parameters
 
1414
    and file contents. This may be different from the terminal encoding
 
1415
    or the filesystem encoding.
 
1416
 
 
1417
    :param  use_cache:  Enable cache for detected encoding.
 
1418
                        (This parameter is turned on by default,
 
1419
                        and required only for selftesting)
 
1420
 
 
1421
    :return: A string defining the preferred user encoding
 
1422
    """
 
1423
    global _cached_user_encoding
 
1424
    if _cached_user_encoding is not None and use_cache:
 
1425
        return _cached_user_encoding
 
1426
 
 
1427
    if sys.platform == 'darwin':
 
1428
        # work around egregious python 2.4 bug
 
1429
        sys.platform = 'posix'
 
1430
        try:
 
1431
            import locale
 
1432
        finally:
 
1433
            sys.platform = 'darwin'
 
1434
    else:
 
1435
        import locale
 
1436
 
 
1437
    try:
 
1438
        user_encoding = locale.getpreferredencoding()
 
1439
    except locale.Error, e:
 
1440
        sys.stderr.write('bzr: warning: %s\n'
 
1441
                         '  Could not determine what text encoding to use.\n'
 
1442
                         '  This error usually means your Python interpreter\n'
 
1443
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1444
                         "  Continuing with ascii encoding.\n"
 
1445
                         % (e, os.environ.get('LANG')))
 
1446
        user_encoding = 'ascii'
 
1447
 
 
1448
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1449
    # treat that as ASCII, and not support printing unicode characters to the
 
1450
    # console.
 
1451
    #
 
1452
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1453
    if user_encoding in (None, 'cp0', ''):
 
1454
        user_encoding = 'ascii'
 
1455
    else:
 
1456
        # check encoding
 
1457
        try:
 
1458
            codecs.lookup(user_encoding)
 
1459
        except LookupError:
 
1460
            sys.stderr.write('bzr: warning:'
 
1461
                             ' unknown encoding %s.'
 
1462
                             ' Continuing with ascii encoding.\n'
 
1463
                             % user_encoding
 
1464
                            )
 
1465
            user_encoding = 'ascii'
 
1466
 
 
1467
    if use_cache:
 
1468
        _cached_user_encoding = user_encoding
 
1469
 
 
1470
    return user_encoding
 
1471
 
 
1472
 
 
1473
def get_host_name():
 
1474
    """Return the current unicode host name.
 
1475
 
 
1476
    This is meant to be used in place of socket.gethostname() because that
 
1477
    behaves inconsistently on different platforms.
 
1478
    """
 
1479
    if sys.platform == "win32":
 
1480
        import win32utils
 
1481
        return win32utils.get_host_name()
 
1482
    else:
 
1483
        import socket
 
1484
        return socket.gethostname().decode(get_user_encoding())
 
1485
 
 
1486
 
 
1487
def recv_all(socket, bytes):
 
1488
    """Receive an exact number of bytes.
 
1489
 
 
1490
    Regular Socket.recv() may return less than the requested number of bytes,
 
1491
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1492
    on all platforms, but this should work everywhere.  This will return
 
1493
    less than the requested amount if the remote end closes.
 
1494
 
 
1495
    This isn't optimized and is intended mostly for use in testing.
 
1496
    """
 
1497
    b = ''
 
1498
    while len(b) < bytes:
 
1499
        new = socket.recv(bytes - len(b))
 
1500
        if new == '':
 
1501
            break # eof
 
1502
        b += new
 
1503
    return b
 
1504
 
 
1505
 
 
1506
def send_all(socket, bytes):
 
1507
    """Send all bytes on a socket.
 
1508
 
 
1509
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1510
    implementation sends no more than 64k at a time, which avoids this problem.
 
1511
    """
 
1512
    chunk_size = 2**16
 
1513
    for pos in xrange(0, len(bytes), chunk_size):
 
1514
        socket.sendall(bytes[pos:pos+chunk_size])
 
1515
 
 
1516
 
 
1517
def dereference_path(path):
 
1518
    """Determine the real path to a file.
 
1519
 
 
1520
    All parent elements are dereferenced.  But the file itself is not
 
1521
    dereferenced.
 
1522
    :param path: The original path.  May be absolute or relative.
 
1523
    :return: the real path *to* the file
 
1524
    """
 
1525
    parent, base = os.path.split(path)
 
1526
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1527
    # (initial path components aren't dereferenced)
 
1528
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1529
 
 
1530
 
 
1531
def supports_mapi():
 
1532
    """Return True if we can use MAPI to launch a mail client."""
 
1533
    return sys.platform == "win32"
 
1534
 
 
1535
 
 
1536
def resource_string(package, resource_name):
 
1537
    """Load a resource from a package and return it as a string.
 
1538
 
 
1539
    Note: Only packages that start with bzrlib are currently supported.
 
1540
 
 
1541
    This is designed to be a lightweight implementation of resource
 
1542
    loading in a way which is API compatible with the same API from
 
1543
    pkg_resources. See
 
1544
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
 
1545
    If and when pkg_resources becomes a standard library, this routine
 
1546
    can delegate to it.
 
1547
    """
 
1548
    # Check package name is within bzrlib
 
1549
    if package == "bzrlib":
 
1550
        resource_relpath = resource_name
 
1551
    elif package.startswith("bzrlib."):
 
1552
        package = package[len("bzrlib."):].replace('.', os.sep)
 
1553
        resource_relpath = pathjoin(package, resource_name)
 
1554
    else:
 
1555
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
1556
 
 
1557
    # Map the resource to a file and read its contents
 
1558
    base = dirname(bzrlib.__file__)
 
1559
    if getattr(sys, 'frozen', None):    # bzr.exe
 
1560
        base = abspath(pathjoin(base, '..', '..'))
 
1561
    filename = pathjoin(base, resource_relpath)
 
1562
    return open(filename, 'rU').read()
 
1563
 
 
1564
 
 
1565
try:
 
1566
    from bzrlib._readdir_pyx import read_dir as _read_dir
 
1567
except ImportError:
 
1568
    from bzrlib._readdir_py import read_dir as _read_dir