← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2006-06-13 13:24:40 UTC
  • mfrom: (1767 +trunk)
  • mto: (1769.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1770.
  • Revision ID: jelmer@samba.org-20060613132440-24e222a86f948f60
[merge] bzr.dev

Show diffs side-by-side

added added

removed removed

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