~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: 2007-08-17 17:49:34 UTC
  • mfrom: (2520.6.5 bundle-fix)
  • Revision ID: pqm@pqm.ubuntu.com-20070817174934-5094ol577uv7ys4u
Fix bundle installation wrong-versionedfile bug

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
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
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
 
import os, types, re, time, types
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from errors import bailout
 
17
from cStringIO import StringIO
 
18
import os
 
19
import re
 
20
import stat
 
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
23
import sys
 
24
import time
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
 
28
import codecs
 
29
from datetime import datetime
 
30
import errno
 
31
from ntpath import (abspath as _nt_abspath,
 
32
                    join as _nt_join,
 
33
                    normpath as _nt_normpath,
 
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
 
36
                    )
 
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
 
 
56
import bzrlib
 
57
from bzrlib import symbol_versioning
 
58
from bzrlib.symbol_versioning import (
 
59
    deprecated_function,
 
60
    )
 
61
from bzrlib.trace import mutter
 
62
 
 
63
 
 
64
# On win32, O_BINARY is used to indicate the file should
 
65
# be opened in binary mode, rather than text mode.
 
66
# On other platforms, O_BINARY doesn't exist, because
 
67
# they always open in binary mode, so it is okay to
 
68
# OR with 0 on those platforms
 
69
O_BINARY = getattr(os, 'O_BINARY', 0)
 
70
 
 
71
# On posix, use lstat instead of stat so that we can
 
72
# operate on broken symlinks. On Windows revert to stat.
 
73
lstat = getattr(os, 'lstat', os.stat)
23
74
 
24
75
def make_readonly(filename):
25
76
    """Make a filename read-only."""
26
 
    # TODO: probably needs to be fixed for windows
27
 
    mod = os.stat(filename).st_mode
28
 
    mod = mod & 0777555
29
 
    os.chmod(filename, mod)
 
77
    mod = lstat(filename).st_mode
 
78
    if not stat.S_ISLNK(mod):
 
79
        mod = mod & 0777555
 
80
        os.chmod(filename, mod)
30
81
 
31
82
 
32
83
def make_writable(filename):
33
 
    mod = os.stat(filename).st_mode
34
 
    mod = mod | 0200
35
 
    os.chmod(filename, mod)
36
 
 
37
 
 
38
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
84
    mod = lstat(filename).st_mode
 
85
    if not stat.S_ISLNK(mod):
 
86
        mod = mod | 0200
 
87
        os.chmod(filename, mod)
 
88
 
 
89
 
 
90
_QUOTE_RE = None
 
91
 
 
92
 
39
93
def quotefn(f):
40
 
    """Return shell-quoted filename"""
41
 
    ## We could be a bit more terse by using double-quotes etc
42
 
    f = _QUOTE_RE.sub(r'\\\1', f)
43
 
    if f[0] == '~':
44
 
        f[0:1] = r'\~' 
45
 
    return f
46
 
 
47
 
 
48
 
def file_kind(f):
49
 
    mode = os.lstat(f)[ST_MODE]
50
 
    if S_ISREG(mode):
51
 
        return 'file'
52
 
    elif S_ISDIR(mode):
53
 
        return 'directory'
54
 
    elif S_ISLNK(mode):
55
 
        return 'symlink'
56
 
    else:
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
58
 
 
 
94
    """Return a quoted filename filename
 
95
 
 
96
    This previously used backslash quoting, but that works poorly on
 
97
    Windows."""
 
98
    # TODO: I'm not really sure this is the best format either.x
 
99
    global _QUOTE_RE
 
100
    if _QUOTE_RE is None:
 
101
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
102
        
 
103
    if _QUOTE_RE.search(f):
 
104
        return '"' + f + '"'
 
105
    else:
 
106
        return f
 
107
 
 
108
 
 
109
_directory_kind = 'directory'
 
110
 
 
111
_formats = {
 
112
    stat.S_IFDIR:_directory_kind,
 
113
    stat.S_IFCHR:'chardev',
 
114
    stat.S_IFBLK:'block',
 
115
    stat.S_IFREG:'file',
 
116
    stat.S_IFIFO:'fifo',
 
117
    stat.S_IFLNK:'symlink',
 
118
    stat.S_IFSOCK:'socket',
 
119
}
 
120
 
 
121
 
 
122
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
123
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
124
 
 
125
    Its performance is critical: Do not mutate without careful benchmarking.
 
126
    """
 
127
    try:
 
128
        return _formats[stat_mode & 0170000]
 
129
    except KeyError:
 
130
        return _unknown
 
131
 
 
132
 
 
133
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
134
    try:
 
135
        return _mapper(_lstat(f).st_mode)
 
136
    except OSError, e:
 
137
        if getattr(e, 'errno', None) == errno.ENOENT:
 
138
            raise errors.NoSuchFile(f)
 
139
        raise
 
140
 
 
141
 
 
142
def get_umask():
 
143
    """Return the current umask"""
 
144
    # Assume that people aren't messing with the umask while running
 
145
    # XXX: This is not thread safe, but there is no way to get the
 
146
    #      umask without setting it
 
147
    umask = os.umask(0)
 
148
    os.umask(umask)
 
149
    return umask
 
150
 
 
151
 
 
152
_kind_marker_map = {
 
153
    "file": "",
 
154
    _directory_kind: "/",
 
155
    "symlink": "@",
 
156
    'tree-reference': '+',
 
157
}
 
158
 
 
159
 
 
160
def kind_marker(kind):
 
161
    try:
 
162
        return _kind_marker_map[kind]
 
163
    except KeyError:
 
164
        raise errors.BzrError('invalid file kind %r' % kind)
 
165
 
 
166
 
 
167
lexists = getattr(os.path, 'lexists', None)
 
168
if lexists is None:
 
169
    def lexists(f):
 
170
        try:
 
171
            stat = getattr(os, 'lstat', os.stat)
 
172
            stat(f)
 
173
            return True
 
174
        except OSError, e:
 
175
            if e.errno == errno.ENOENT:
 
176
                return False;
 
177
            else:
 
178
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
179
 
 
180
 
 
181
def fancy_rename(old, new, rename_func, unlink_func):
 
182
    """A fancy rename, when you don't have atomic rename.
 
183
    
 
184
    :param old: The old path, to rename from
 
185
    :param new: The new path, to rename to
 
186
    :param rename_func: The potentially non-atomic rename function
 
187
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
188
    """
 
189
 
 
190
    # sftp rename doesn't allow overwriting, so play tricks:
 
191
    import random
 
192
    base = os.path.basename(new)
 
193
    dirname = os.path.dirname(new)
 
194
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
195
    tmp_name = pathjoin(dirname, tmp_name)
 
196
 
 
197
    # Rename the file out of the way, but keep track if it didn't exist
 
198
    # We don't want to grab just any exception
 
199
    # something like EACCES should prevent us from continuing
 
200
    # The downside is that the rename_func has to throw an exception
 
201
    # with an errno = ENOENT, or NoSuchFile
 
202
    file_existed = False
 
203
    try:
 
204
        rename_func(new, tmp_name)
 
205
    except (errors.NoSuchFile,), e:
 
206
        pass
 
207
    except IOError, e:
 
208
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
209
        # function raises an IOError with errno is None when a rename fails.
 
210
        # This then gets caught here.
 
211
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
212
            raise
 
213
    except Exception, e:
 
214
        if (getattr(e, 'errno', None) is None
 
215
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
216
            raise
 
217
    else:
 
218
        file_existed = True
 
219
 
 
220
    success = False
 
221
    try:
 
222
        # This may throw an exception, in which case success will
 
223
        # not be set.
 
224
        rename_func(old, new)
 
225
        success = True
 
226
    finally:
 
227
        if file_existed:
 
228
            # If the file used to exist, rename it back into place
 
229
            # otherwise just delete it from the tmp location
 
230
            if success:
 
231
                unlink_func(tmp_name)
 
232
            else:
 
233
                rename_func(tmp_name, new)
 
234
 
 
235
 
 
236
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
237
# choke on a Unicode string containing a relative path if
 
238
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
239
# string.
 
240
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
241
def _posix_abspath(path):
 
242
    # jam 20060426 rather than encoding to fsencoding
 
243
    # copy posixpath.abspath, but use os.getcwdu instead
 
244
    if not posixpath.isabs(path):
 
245
        path = posixpath.join(getcwd(), path)
 
246
    return posixpath.normpath(path)
 
247
 
 
248
 
 
249
def _posix_realpath(path):
 
250
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
251
 
 
252
 
 
253
def _win32_fixdrive(path):
 
254
    """Force drive letters to be consistent.
 
255
 
 
256
    win32 is inconsistent whether it returns lower or upper case
 
257
    and even if it was consistent the user might type the other
 
258
    so we force it to uppercase
 
259
    running python.exe under cmd.exe return capital C:\\
 
260
    running win32 python inside a cygwin shell returns lowercase c:\\
 
261
    """
 
262
    drive, path = _nt_splitdrive(path)
 
263
    return drive.upper() + path
 
264
 
 
265
 
 
266
def _win32_abspath(path):
 
267
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
268
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
269
 
 
270
 
 
271
def _win98_abspath(path):
 
272
    """Return the absolute version of a path.
 
273
    Windows 98 safe implementation (python reimplementation
 
274
    of Win32 API function GetFullPathNameW)
 
275
    """
 
276
    # Corner cases:
 
277
    #   C:\path     => C:/path
 
278
    #   C:/path     => C:/path
 
279
    #   \\HOST\path => //HOST/path
 
280
    #   //HOST/path => //HOST/path
 
281
    #   path        => C:/cwd/path
 
282
    #   /path       => C:/path
 
283
    path = unicode(path)
 
284
    # check for absolute path
 
285
    drive = _nt_splitdrive(path)[0]
 
286
    if drive == '' and path[:2] not in('//','\\\\'):
 
287
        cwd = os.getcwdu()
 
288
        # we cannot simply os.path.join cwd and path
 
289
        # because os.path.join('C:','/path') produce '/path'
 
290
        # and this is incorrect
 
291
        if path[:1] in ('/','\\'):
 
292
            cwd = _nt_splitdrive(cwd)[0]
 
293
            path = path[1:]
 
294
        path = cwd + '\\' + path
 
295
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
296
 
 
297
if win32utils.winver == 'Windows 98':
 
298
    _win32_abspath = _win98_abspath
 
299
 
 
300
 
 
301
def _win32_realpath(path):
 
302
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
303
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
304
 
 
305
 
 
306
def _win32_pathjoin(*args):
 
307
    return _nt_join(*args).replace('\\', '/')
 
308
 
 
309
 
 
310
def _win32_normpath(path):
 
311
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
312
 
 
313
 
 
314
def _win32_getcwd():
 
315
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
316
 
 
317
 
 
318
def _win32_mkdtemp(*args, **kwargs):
 
319
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
320
 
 
321
 
 
322
def _win32_rename(old, new):
 
323
    """We expect to be able to atomically replace 'new' with old.
 
324
 
 
325
    On win32, if new exists, it must be moved out of the way first,
 
326
    and then deleted. 
 
327
    """
 
328
    try:
 
329
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
330
    except OSError, e:
 
331
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
332
            # If we try to rename a non-existant file onto cwd, we get 
 
333
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
334
            # if the old path doesn't exist, sometimes we get EACCES
 
335
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
336
            os.lstat(old)
 
337
        raise
 
338
 
 
339
 
 
340
def _mac_getcwd():
 
341
    return unicodedata.normalize('NFKC', os.getcwdu())
 
342
 
 
343
 
 
344
# Default is to just use the python builtins, but these can be rebound on
 
345
# particular platforms.
 
346
abspath = _posix_abspath
 
347
realpath = _posix_realpath
 
348
pathjoin = os.path.join
 
349
normpath = os.path.normpath
 
350
getcwd = os.getcwdu
 
351
rename = os.rename
 
352
dirname = os.path.dirname
 
353
basename = os.path.basename
 
354
split = os.path.split
 
355
splitext = os.path.splitext
 
356
# These were already imported into local scope
 
357
# mkdtemp = tempfile.mkdtemp
 
358
# rmtree = shutil.rmtree
 
359
 
 
360
MIN_ABS_PATHLENGTH = 1
 
361
 
 
362
 
 
363
if sys.platform == 'win32':
 
364
    abspath = _win32_abspath
 
365
    realpath = _win32_realpath
 
366
    pathjoin = _win32_pathjoin
 
367
    normpath = _win32_normpath
 
368
    getcwd = _win32_getcwd
 
369
    mkdtemp = _win32_mkdtemp
 
370
    rename = _win32_rename
 
371
 
 
372
    MIN_ABS_PATHLENGTH = 3
 
373
 
 
374
    def _win32_delete_readonly(function, path, excinfo):
 
375
        """Error handler for shutil.rmtree function [for win32]
 
376
        Helps to remove files and dirs marked as read-only.
 
377
        """
 
378
        exception = excinfo[1]
 
379
        if function in (os.remove, os.rmdir) \
 
380
            and isinstance(exception, OSError) \
 
381
            and exception.errno == errno.EACCES:
 
382
            make_writable(path)
 
383
            function(path)
 
384
        else:
 
385
            raise
 
386
 
 
387
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
388
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
389
        return shutil.rmtree(path, ignore_errors, onerror)
 
390
elif sys.platform == 'darwin':
 
391
    getcwd = _mac_getcwd
 
392
 
 
393
 
 
394
def get_terminal_encoding():
 
395
    """Find the best encoding for printing to the screen.
 
396
 
 
397
    This attempts to check both sys.stdout and sys.stdin to see
 
398
    what encoding they are in, and if that fails it falls back to
 
399
    bzrlib.user_encoding.
 
400
    The problem is that on Windows, locale.getpreferredencoding()
 
401
    is not the same encoding as that used by the console:
 
402
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
403
 
 
404
    On my standard US Windows XP, the preferred encoding is
 
405
    cp1252, but the console is cp437
 
406
    """
 
407
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
408
    if not output_encoding:
 
409
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
410
        if not input_encoding:
 
411
            output_encoding = bzrlib.user_encoding
 
412
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
413
        else:
 
414
            output_encoding = input_encoding
 
415
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
416
    else:
 
417
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
418
    if output_encoding == 'cp0':
 
419
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
420
        output_encoding = bzrlib.user_encoding
 
421
        mutter('cp0 is invalid encoding.'
 
422
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
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, bzrlib.user_encoding)
 
431
                        )
 
432
        output_encoding = bzrlib.user_encoding
 
433
 
 
434
    return output_encoding
 
435
 
 
436
 
 
437
def normalizepath(f):
 
438
    if getattr(os.path, 'realpath', None) is not None:
 
439
        F = realpath
 
440
    else:
 
441
        F = abspath
 
442
    [p,e] = os.path.split(f)
 
443
    if e == "" or e == "." or e == "..":
 
444
        return F(f)
 
445
    else:
 
446
        return pathjoin(F(p), e)
 
447
 
 
448
 
 
449
def backup_file(fn):
 
450
    """Copy a file to a backup.
 
451
 
 
452
    Backups are named in GNU-style, with a ~ suffix.
 
453
 
 
454
    If the file is already a backup, it's not copied.
 
455
    """
 
456
    if fn[-1] == '~':
 
457
        return
 
458
    bfn = fn + '~'
 
459
 
 
460
    if has_symlinks() and os.path.islink(fn):
 
461
        target = os.readlink(fn)
 
462
        os.symlink(target, bfn)
 
463
        return
 
464
    inf = file(fn, 'rb')
 
465
    try:
 
466
        content = inf.read()
 
467
    finally:
 
468
        inf.close()
 
469
    
 
470
    outf = file(bfn, 'wb')
 
471
    try:
 
472
        outf.write(content)
 
473
    finally:
 
474
        outf.close()
59
475
 
60
476
 
61
477
def isdir(f):
66
482
        return False
67
483
 
68
484
 
69
 
 
70
485
def isfile(f):
71
486
    """True if f is a regular file."""
72
487
    try:
74
489
    except OSError:
75
490
        return False
76
491
 
 
492
def islink(f):
 
493
    """True if f is a symlink."""
 
494
    try:
 
495
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
496
    except OSError:
 
497
        return False
 
498
 
 
499
def is_inside(dir, fname):
 
500
    """True if fname is inside dir.
 
501
    
 
502
    The parameters should typically be passed to osutils.normpath first, so
 
503
    that . and .. and repeated slashes are eliminated, and the separators
 
504
    are canonical for the platform.
 
505
    
 
506
    The empty string as a dir name is taken as top-of-tree and matches 
 
507
    everything.
 
508
    """
 
509
    # XXX: Most callers of this can actually do something smarter by 
 
510
    # looking at the inventory
 
511
    if dir == fname:
 
512
        return True
 
513
    
 
514
    if dir == '':
 
515
        return True
 
516
 
 
517
    if dir[-1] != '/':
 
518
        dir += '/'
 
519
 
 
520
    return fname.startswith(dir)
 
521
 
 
522
 
 
523
def is_inside_any(dir_list, fname):
 
524
    """True if fname is inside any of given dirs."""
 
525
    for dirname in dir_list:
 
526
        if is_inside(dirname, fname):
 
527
            return True
 
528
    return False
 
529
 
 
530
 
 
531
def is_inside_or_parent_of_any(dir_list, fname):
 
532
    """True if fname is a child or a parent of any of the given files."""
 
533
    for dirname in dir_list:
 
534
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
535
            return True
 
536
    return False
 
537
 
77
538
 
78
539
def pumpfile(fromfile, tofile):
79
540
    """Copy contents of one file to another."""
80
 
    tofile.write(fromfile.read())
81
 
 
82
 
 
83
 
def uuid():
84
 
    """Return a new UUID"""
85
 
    
86
 
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
87
 
    ## Linux, but we need something portable for other systems;
88
 
    ## preferably an implementation in Python.
89
 
    try:
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
91
 
    except IOError:
92
 
        return chomp(os.popen('uuidgen').readline())
93
 
 
94
 
 
95
 
def chomp(s):
96
 
    if s and (s[-1] == '\n'):
97
 
        return s[:-1]
98
 
    else:
99
 
        return s
 
541
    BUFSIZE = 32768
 
542
    while True:
 
543
        b = fromfile.read(BUFSIZE)
 
544
        if not b:
 
545
            break
 
546
        tofile.write(b)
 
547
 
 
548
 
 
549
def file_iterator(input_file, readsize=32768):
 
550
    while True:
 
551
        b = input_file.read(readsize)
 
552
        if len(b) == 0:
 
553
            break
 
554
        yield b
100
555
 
101
556
 
102
557
def sha_file(f):
103
 
    import sha
104
 
    ## TODO: Maybe read in chunks to handle big files
105
 
    if hasattr(f, 'tell'):
 
558
    if getattr(f, 'tell', None) is not None:
106
559
        assert f.tell() == 0
107
560
    s = sha.new()
108
 
    s.update(f.read())
 
561
    BUFSIZE = 128<<10
 
562
    while True:
 
563
        b = f.read(BUFSIZE)
 
564
        if not b:
 
565
            break
 
566
        s.update(b)
 
567
    return s.hexdigest()
 
568
 
 
569
 
 
570
 
 
571
def sha_strings(strings):
 
572
    """Return the sha-1 of concatenation of strings"""
 
573
    s = sha.new()
 
574
    map(s.update, strings)
109
575
    return s.hexdigest()
110
576
 
111
577
 
112
578
def sha_string(f):
113
 
    import sha
114
579
    s = sha.new()
115
580
    s.update(f)
116
581
    return s.hexdigest()
117
582
 
118
583
 
119
 
 
120
 
def username():
121
 
    """Return email-style username.
122
 
 
123
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
124
 
 
125
 
    :todo: Check it's reasonably well-formed.
126
 
 
127
 
    :todo: Allow taking it from a dotfile to help people on windows
128
 
           who can't easily set variables.
129
 
 
130
 
    :todo: Cope without pwd module, which is only on unix. 
131
 
    """
132
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
133
 
    if e: return e
134
 
 
135
 
    import socket
136
 
    
137
 
    try:
138
 
        import pwd
139
 
        uid = os.getuid()
140
 
        w = pwd.getpwuid(uid)
141
 
        gecos = w.pw_gecos
142
 
        comma = gecos.find(',')
143
 
        if comma == -1:
144
 
            realname = gecos
145
 
        else:
146
 
            realname = gecos[:comma]
147
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
148
 
    except ImportError:
149
 
        pass
150
 
 
151
 
    import getpass, socket
152
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
153
 
 
154
 
 
155
 
def user_email():
156
 
    """Return just the email component of a username."""
157
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
158
 
    if e:
159
 
        import re
160
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
161
 
        if not m:
162
 
            bailout('%r is not a reasonable email address' % e)
163
 
        return m.group(0)
164
 
 
165
 
 
166
 
    import getpass, socket
167
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
168
 
 
169
 
    
 
584
def fingerprint_file(f):
 
585
    s = sha.new()
 
586
    b = f.read()
 
587
    s.update(b)
 
588
    size = len(b)
 
589
    return {'size': size,
 
590
            'sha1': s.hexdigest()}
170
591
 
171
592
 
172
593
def compare_files(a, b):
173
594
    """Returns true if equal in contents"""
174
 
    # TODO: don't read the whole thing in one go.
175
595
    BUFSIZE = 4096
176
596
    while True:
177
597
        ai = a.read(BUFSIZE)
182
602
            return True
183
603
 
184
604
 
185
 
 
186
605
def local_time_offset(t=None):
187
606
    """Return offset of local zone from GMT, either at present or at time t."""
188
 
    # python2.3 localtime() can't take None
189
607
    if t is None:
190
608
        t = time.time()
191
 
        
192
 
    if time.localtime(t).tm_isdst and time.daylight:
193
 
        return -time.altzone
194
 
    else:
195
 
        return -time.timezone
196
 
 
197
 
    
198
 
def format_date(t, offset=0, timezone='original'):
199
 
    ## TODO: Perhaps a global option to use either universal or local time?
200
 
    ## Or perhaps just let people set $TZ?
201
 
    import time
202
 
    
203
 
    assert isinstance(t, float)
204
 
    
 
609
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
610
    return offset.days * 86400 + offset.seconds
 
611
 
 
612
    
 
613
def format_date(t, offset=0, timezone='original', date_fmt=None,
 
614
                show_offset=True):
 
615
    """Return a formatted date string.
 
616
 
 
617
    :param t: Seconds since the epoch.
 
618
    :param offset: Timezone offset in seconds east of utc.
 
619
    :param timezone: How to display the time: 'utc', 'original' for the
 
620
         timezone specified by offset, or 'local' for the process's current
 
621
         timezone.
 
622
    :param show_offset: Whether to append the timezone.
 
623
    :param date_fmt: strftime format.
 
624
    """
205
625
    if timezone == 'utc':
206
626
        tt = time.gmtime(t)
207
627
        offset = 0
208
628
    elif timezone == 'original':
209
 
        if offset == None:
 
629
        if offset is None:
210
630
            offset = 0
211
631
        tt = time.gmtime(t + offset)
212
632
    elif timezone == 'local':
213
633
        tt = time.localtime(t)
214
634
        offset = local_time_offset(t)
215
635
    else:
216
 
        bailout("unsupported timezone format %r",
217
 
                ['options are "utc", "original", "local"'])
218
 
 
219
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
220
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
636
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
637
                              ['options are "utc", "original", "local"'])
 
638
    if date_fmt is None:
 
639
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
640
    if show_offset:
 
641
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
642
    else:
 
643
        offset_str = ''
 
644
    return (time.strftime(date_fmt, tt) +  offset_str)
221
645
 
222
646
 
223
647
def compact_date(when):
224
648
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
225
649
    
226
650
 
 
651
def format_delta(delta):
 
652
    """Get a nice looking string for a time delta.
 
653
 
 
654
    :param delta: The time difference in seconds, can be positive or negative.
 
655
        positive indicates time in the past, negative indicates time in the
 
656
        future. (usually time.time() - stored_time)
 
657
    :return: String formatted to show approximate resolution
 
658
    """
 
659
    delta = int(delta)
 
660
    if delta >= 0:
 
661
        direction = 'ago'
 
662
    else:
 
663
        direction = 'in the future'
 
664
        delta = -delta
 
665
 
 
666
    seconds = delta
 
667
    if seconds < 90: # print seconds up to 90 seconds
 
668
        if seconds == 1:
 
669
            return '%d second %s' % (seconds, direction,)
 
670
        else:
 
671
            return '%d seconds %s' % (seconds, direction)
 
672
 
 
673
    minutes = int(seconds / 60)
 
674
    seconds -= 60 * minutes
 
675
    if seconds == 1:
 
676
        plural_seconds = ''
 
677
    else:
 
678
        plural_seconds = 's'
 
679
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
680
        if minutes == 1:
 
681
            return '%d minute, %d second%s %s' % (
 
682
                    minutes, seconds, plural_seconds, direction)
 
683
        else:
 
684
            return '%d minutes, %d second%s %s' % (
 
685
                    minutes, seconds, plural_seconds, direction)
 
686
 
 
687
    hours = int(minutes / 60)
 
688
    minutes -= 60 * hours
 
689
    if minutes == 1:
 
690
        plural_minutes = ''
 
691
    else:
 
692
        plural_minutes = 's'
 
693
 
 
694
    if hours == 1:
 
695
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
696
                                            plural_minutes, direction)
 
697
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
698
                                         plural_minutes, direction)
227
699
 
228
700
def filesize(f):
229
701
    """Return size of given open file."""
230
702
    return os.fstat(f.fileno())[ST_SIZE]
231
703
 
232
704
 
233
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
705
# Define rand_bytes based on platform.
 
706
try:
 
707
    # Python 2.4 and later have os.urandom,
 
708
    # but it doesn't work on some arches
 
709
    os.urandom(1)
234
710
    rand_bytes = os.urandom
235
 
else:
236
 
    # FIXME: No good on non-Linux
237
 
    _rand_file = file('/dev/urandom', 'rb')
238
 
    rand_bytes = _rand_file.read
 
711
except (NotImplementedError, AttributeError):
 
712
    # If python doesn't have os.urandom, or it doesn't work,
 
713
    # then try to first pull random data from /dev/urandom
 
714
    try:
 
715
        rand_bytes = file('/dev/urandom', 'rb').read
 
716
    # Otherwise, use this hack as a last resort
 
717
    except (IOError, OSError):
 
718
        # not well seeded, but better than nothing
 
719
        def rand_bytes(n):
 
720
            import random
 
721
            s = ''
 
722
            while n:
 
723
                s += chr(random.randint(0, 255))
 
724
                n -= 1
 
725
            return s
 
726
 
 
727
 
 
728
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
729
def rand_chars(num):
 
730
    """Return a random string of num alphanumeric characters
 
731
    
 
732
    The result only contains lowercase chars because it may be used on 
 
733
    case-insensitive filesystems.
 
734
    """
 
735
    s = ''
 
736
    for raw_byte in rand_bytes(num):
 
737
        s += ALNUM[ord(raw_byte) % 36]
 
738
    return s
239
739
 
240
740
 
241
741
## TODO: We could later have path objects that remember their list
242
742
## decomposition (might be too tricksy though.)
243
743
 
244
744
def splitpath(p):
245
 
    """Turn string into list of parts.
246
 
 
247
 
    >>> splitpath('a')
248
 
    ['a']
249
 
    >>> splitpath('a/b')
250
 
    ['a', 'b']
251
 
    >>> splitpath('a/./b')
252
 
    ['a', 'b']
253
 
    >>> splitpath('a/.b')
254
 
    ['a', '.b']
255
 
    >>> splitpath('a/../b')
256
 
    Traceback (most recent call last):
257
 
    ...
258
 
    BzrError: ("sorry, '..' not allowed in path", [])
259
 
    """
260
 
    assert isinstance(p, types.StringTypes)
261
 
    ps = [f for f in p.split('/') if f != '.']
 
745
    """Turn string into list of parts."""
 
746
    assert isinstance(p, basestring)
 
747
 
 
748
    # split on either delimiter because people might use either on
 
749
    # Windows
 
750
    ps = re.split(r'[\\/]', p)
 
751
 
 
752
    rps = []
262
753
    for f in ps:
263
754
        if f == '..':
264
 
            bailout("sorry, %r not allowed in path" % f)
265
 
    return ps
 
755
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
756
        elif (f == '.') or (f == ''):
 
757
            pass
 
758
        else:
 
759
            rps.append(f)
 
760
    return rps
266
761
 
267
762
def joinpath(p):
268
 
    assert isinstance(p, list)
 
763
    assert isinstance(p, (list, tuple))
269
764
    for f in p:
270
765
        if (f == '..') or (f is None) or (f == ''):
271
 
            bailout("sorry, %r not allowed in path" % f)
272
 
    return '/'.join(p)
273
 
 
274
 
 
275
 
def appendpath(p1, p2):
276
 
    if p1 == '':
277
 
        return p2
278
 
    else:
279
 
        return p1 + '/' + p2
280
 
    
281
 
 
282
 
def extern_command(cmd, ignore_errors = False):
283
 
    mutter('external command: %s' % `cmd`)
284
 
    if os.system(cmd):
285
 
        if not ignore_errors:
286
 
            bailout('command failed')
287
 
 
 
766
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
767
    return pathjoin(*p)
 
768
 
 
769
 
 
770
def split_lines(s):
 
771
    """Split s into lines, but without removing the newline characters."""
 
772
    lines = s.split('\n')
 
773
    result = [line + '\n' for line in lines[:-1]]
 
774
    if lines[-1]:
 
775
        result.append(lines[-1])
 
776
    return result
 
777
 
 
778
 
 
779
def hardlinks_good():
 
780
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
781
 
 
782
 
 
783
def link_or_copy(src, dest):
 
784
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
785
    if not hardlinks_good():
 
786
        shutil.copyfile(src, dest)
 
787
        return
 
788
    try:
 
789
        os.link(src, dest)
 
790
    except (OSError, IOError), e:
 
791
        if e.errno != errno.EXDEV:
 
792
            raise
 
793
        shutil.copyfile(src, dest)
 
794
 
 
795
def delete_any(full_path):
 
796
    """Delete a file or directory."""
 
797
    try:
 
798
        os.unlink(full_path)
 
799
    except OSError, e:
 
800
    # We may be renaming a dangling inventory id
 
801
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
802
            raise
 
803
        os.rmdir(full_path)
 
804
 
 
805
 
 
806
def has_symlinks():
 
807
    if getattr(os, 'symlink', None) is not None:
 
808
        return True
 
809
    else:
 
810
        return False
 
811
        
 
812
 
 
813
def contains_whitespace(s):
 
814
    """True if there are any whitespace characters in s."""
 
815
    # string.whitespace can include '\xa0' in certain locales, because it is
 
816
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
817
    # 1) Isn't a breaking whitespace
 
818
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
819
    #    separators
 
820
    # 3) '\xa0' isn't unicode safe since it is >128.
 
821
 
 
822
    # This should *not* be a unicode set of characters in case the source
 
823
    # string is not a Unicode string. We can auto-up-cast the characters since
 
824
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
825
    # is utf-8
 
826
    for ch in ' \t\n\r\v\f':
 
827
        if ch in s:
 
828
            return True
 
829
    else:
 
830
        return False
 
831
 
 
832
 
 
833
def contains_linebreaks(s):
 
834
    """True if there is any vertical whitespace in s."""
 
835
    for ch in '\f\n\r':
 
836
        if ch in s:
 
837
            return True
 
838
    else:
 
839
        return False
 
840
 
 
841
 
 
842
def relpath(base, path):
 
843
    """Return path relative to base, or raise exception.
 
844
 
 
845
    The path may be either an absolute path or a path relative to the
 
846
    current working directory.
 
847
 
 
848
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
849
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
850
    avoids that problem.
 
851
    """
 
852
 
 
853
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
854
        ' exceed the platform minimum length (which is %d)' % 
 
855
        MIN_ABS_PATHLENGTH)
 
856
 
 
857
    rp = abspath(path)
 
858
 
 
859
    s = []
 
860
    head = rp
 
861
    while len(head) >= len(base):
 
862
        if head == base:
 
863
            break
 
864
        head, tail = os.path.split(head)
 
865
        if tail:
 
866
            s.insert(0, tail)
 
867
    else:
 
868
        raise errors.PathNotChild(rp, base)
 
869
 
 
870
    if s:
 
871
        return pathjoin(*s)
 
872
    else:
 
873
        return ''
 
874
 
 
875
 
 
876
def safe_unicode(unicode_or_utf8_string):
 
877
    """Coerce unicode_or_utf8_string into unicode.
 
878
 
 
879
    If it is unicode, it is returned.
 
880
    Otherwise it is decoded from utf-8. If a decoding error
 
881
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
882
    as a BzrBadParameter exception.
 
883
    """
 
884
    if isinstance(unicode_or_utf8_string, unicode):
 
885
        return unicode_or_utf8_string
 
886
    try:
 
887
        return unicode_or_utf8_string.decode('utf8')
 
888
    except UnicodeDecodeError:
 
889
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
890
 
 
891
 
 
892
def safe_utf8(unicode_or_utf8_string):
 
893
    """Coerce unicode_or_utf8_string to a utf8 string.
 
894
 
 
895
    If it is a str, it is returned.
 
896
    If it is Unicode, it is encoded into a utf-8 string.
 
897
    """
 
898
    if isinstance(unicode_or_utf8_string, str):
 
899
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
900
        #       performance if we are dealing with lots of apis that want a
 
901
        #       utf-8 revision id
 
902
        try:
 
903
            # Make sure it is a valid utf-8 string
 
904
            unicode_or_utf8_string.decode('utf-8')
 
905
        except UnicodeDecodeError:
 
906
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
907
        return unicode_or_utf8_string
 
908
    return unicode_or_utf8_string.encode('utf-8')
 
909
 
 
910
 
 
911
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
912
                        ' Revision id generators should be creating utf8'
 
913
                        ' revision ids.')
 
914
 
 
915
 
 
916
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
917
    """Revision ids should now be utf8, but at one point they were unicode.
 
918
 
 
919
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
920
        utf8 or None).
 
921
    :param warn: Functions that are sanitizing user data can set warn=False
 
922
    :return: None or a utf8 revision id.
 
923
    """
 
924
    if (unicode_or_utf8_string is None
 
925
        or unicode_or_utf8_string.__class__ == str):
 
926
        return unicode_or_utf8_string
 
927
    if warn:
 
928
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
929
                               stacklevel=2)
 
930
    return cache_utf8.encode(unicode_or_utf8_string)
 
931
 
 
932
 
 
933
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
934
                    ' generators should be creating utf8 file ids.')
 
935
 
 
936
 
 
937
def safe_file_id(unicode_or_utf8_string, warn=True):
 
938
    """File ids should now be utf8, but at one point they were unicode.
 
939
 
 
940
    This is the same as safe_utf8, except it uses the cached encode functions
 
941
    to save a little bit of performance.
 
942
 
 
943
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
944
        utf8 or None).
 
945
    :param warn: Functions that are sanitizing user data can set warn=False
 
946
    :return: None or a utf8 file id.
 
947
    """
 
948
    if (unicode_or_utf8_string is None
 
949
        or unicode_or_utf8_string.__class__ == str):
 
950
        return unicode_or_utf8_string
 
951
    if warn:
 
952
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
953
                               stacklevel=2)
 
954
    return cache_utf8.encode(unicode_or_utf8_string)
 
955
 
 
956
 
 
957
_platform_normalizes_filenames = False
 
958
if sys.platform == 'darwin':
 
959
    _platform_normalizes_filenames = True
 
960
 
 
961
 
 
962
def normalizes_filenames():
 
963
    """Return True if this platform normalizes unicode filenames.
 
964
 
 
965
    Mac OSX does, Windows/Linux do not.
 
966
    """
 
967
    return _platform_normalizes_filenames
 
968
 
 
969
 
 
970
def _accessible_normalized_filename(path):
 
971
    """Get the unicode normalized path, and if you can access the file.
 
972
 
 
973
    On platforms where the system normalizes filenames (Mac OSX),
 
974
    you can access a file by any path which will normalize correctly.
 
975
    On platforms where the system does not normalize filenames 
 
976
    (Windows, Linux), you have to access a file by its exact path.
 
977
 
 
978
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
979
    the standard for XML documents.
 
980
 
 
981
    So return the normalized path, and a flag indicating if the file
 
982
    can be accessed by that path.
 
983
    """
 
984
 
 
985
    return unicodedata.normalize('NFKC', unicode(path)), True
 
986
 
 
987
 
 
988
def _inaccessible_normalized_filename(path):
 
989
    __doc__ = _accessible_normalized_filename.__doc__
 
990
 
 
991
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
992
    return normalized, normalized == path
 
993
 
 
994
 
 
995
if _platform_normalizes_filenames:
 
996
    normalized_filename = _accessible_normalized_filename
 
997
else:
 
998
    normalized_filename = _inaccessible_normalized_filename
 
999
 
 
1000
 
 
1001
def terminal_width():
 
1002
    """Return estimated terminal width."""
 
1003
    if sys.platform == 'win32':
 
1004
        return win32utils.get_console_size()[0]
 
1005
    width = 0
 
1006
    try:
 
1007
        import struct, fcntl, termios
 
1008
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
1009
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
1010
        width = struct.unpack('HHHH', x)[1]
 
1011
    except IOError:
 
1012
        pass
 
1013
    if width <= 0:
 
1014
        try:
 
1015
            width = int(os.environ['COLUMNS'])
 
1016
        except:
 
1017
            pass
 
1018
    if width <= 0:
 
1019
        width = 80
 
1020
 
 
1021
    return width
 
1022
 
 
1023
 
 
1024
def supports_executable():
 
1025
    return sys.platform != "win32"
 
1026
 
 
1027
 
 
1028
def supports_posix_readonly():
 
1029
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1030
 
 
1031
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1032
    directory controls creation/deletion, etc.
 
1033
 
 
1034
    And under win32, readonly means that the directory itself cannot be
 
1035
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1036
    where files in readonly directories cannot be added, deleted or renamed.
 
1037
    """
 
1038
    return sys.platform != "win32"
 
1039
 
 
1040
 
 
1041
def set_or_unset_env(env_variable, value):
 
1042
    """Modify the environment, setting or removing the env_variable.
 
1043
 
 
1044
    :param env_variable: The environment variable in question
 
1045
    :param value: The value to set the environment to. If None, then
 
1046
        the variable will be removed.
 
1047
    :return: The original value of the environment variable.
 
1048
    """
 
1049
    orig_val = os.environ.get(env_variable)
 
1050
    if value is None:
 
1051
        if orig_val is not None:
 
1052
            del os.environ[env_variable]
 
1053
    else:
 
1054
        if isinstance(value, unicode):
 
1055
            value = value.encode(bzrlib.user_encoding)
 
1056
        os.environ[env_variable] = value
 
1057
    return orig_val
 
1058
 
 
1059
 
 
1060
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
1061
 
 
1062
 
 
1063
def check_legal_path(path):
 
1064
    """Check whether the supplied path is legal.  
 
1065
    This is only required on Windows, so we don't test on other platforms
 
1066
    right now.
 
1067
    """
 
1068
    if sys.platform != "win32":
 
1069
        return
 
1070
    if _validWin32PathRE.match(path) is None:
 
1071
        raise errors.IllegalPath(path)
 
1072
 
 
1073
 
 
1074
def walkdirs(top, prefix=""):
 
1075
    """Yield data about all the directories in a tree.
 
1076
    
 
1077
    This yields all the data about the contents of a directory at a time.
 
1078
    After each directory has been yielded, if the caller has mutated the list
 
1079
    to exclude some directories, they are then not descended into.
 
1080
    
 
1081
    The data yielded is of the form:
 
1082
    ((directory-relpath, directory-path-from-top),
 
1083
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
1084
     - directory-relpath is the relative path of the directory being returned
 
1085
       with respect to top. prefix is prepended to this.
 
1086
     - directory-path-from-root is the path including top for this directory. 
 
1087
       It is suitable for use with os functions.
 
1088
     - relpath is the relative path within the subtree being walked.
 
1089
     - basename is the basename of the path
 
1090
     - kind is the kind of the file now. If unknown then the file is not
 
1091
       present within the tree - but it may be recorded as versioned. See
 
1092
       versioned_kind.
 
1093
     - lstat is the stat data *if* the file was statted.
 
1094
     - planned, not implemented: 
 
1095
       path_from_tree_root is the path from the root of the tree.
 
1096
 
 
1097
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1098
        allows one to walk a subtree but get paths that are relative to a tree
 
1099
        rooted higher up.
 
1100
    :return: an iterator over the dirs.
 
1101
    """
 
1102
    #TODO there is a bit of a smell where the results of the directory-
 
1103
    # summary in this, and the path from the root, may not agree 
 
1104
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
1105
    # potentially confusing output. We should make this more robust - but
 
1106
    # not at a speed cost. RBC 20060731
 
1107
    _lstat = os.lstat
 
1108
    _directory = _directory_kind
 
1109
    _listdir = os.listdir
 
1110
    _kind_from_mode = _formats.get
 
1111
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
1112
    while pending:
 
1113
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1114
        relroot, _, _, _, top = pending.pop()
 
1115
        if relroot:
 
1116
            relprefix = relroot + u'/'
 
1117
        else:
 
1118
            relprefix = ''
 
1119
        top_slash = top + u'/'
 
1120
 
 
1121
        dirblock = []
 
1122
        append = dirblock.append
 
1123
        for name in sorted(_listdir(top)):
 
1124
            abspath = top_slash + name
 
1125
            statvalue = _lstat(abspath)
 
1126
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1127
            append((relprefix + name, name, kind, statvalue, abspath))
 
1128
        yield (relroot, top), dirblock
 
1129
 
 
1130
        # push the user specified dirs from dirblock
 
1131
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1132
 
 
1133
 
 
1134
def _walkdirs_utf8(top, prefix=""):
 
1135
    """Yield data about all the directories in a tree.
 
1136
 
 
1137
    This yields the same information as walkdirs() only each entry is yielded
 
1138
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1139
    are returned as exact byte-strings.
 
1140
 
 
1141
    :return: yields a tuple of (dir_info, [file_info])
 
1142
        dir_info is (utf8_relpath, path-from-top)
 
1143
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1144
        if top is an absolute path, path-from-top is also an absolute path.
 
1145
        path-from-top might be unicode or utf8, but it is the correct path to
 
1146
        pass to os functions to affect the file in question. (such as os.lstat)
 
1147
    """
 
1148
    fs_encoding = _fs_enc.upper()
 
1149
    if (sys.platform == 'win32' or
 
1150
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
 
1151
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
 
1152
    else:
 
1153
        return _walkdirs_fs_utf8(top, prefix=prefix)
 
1154
 
 
1155
 
 
1156
def _walkdirs_fs_utf8(top, prefix=""):
 
1157
    """See _walkdirs_utf8.
 
1158
 
 
1159
    This sub-function is called when we know the filesystem is already in utf8
 
1160
    encoding. So we don't need to transcode filenames.
 
1161
    """
 
1162
    _lstat = os.lstat
 
1163
    _directory = _directory_kind
 
1164
    _listdir = os.listdir
 
1165
    _kind_from_mode = _formats.get
 
1166
 
 
1167
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1168
    # But we don't actually uses 1-3 in pending, so set them to None
 
1169
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1170
    while pending:
 
1171
        relroot, _, _, _, top = pending.pop()
 
1172
        if relroot:
 
1173
            relprefix = relroot + '/'
 
1174
        else:
 
1175
            relprefix = ''
 
1176
        top_slash = top + '/'
 
1177
 
 
1178
        dirblock = []
 
1179
        append = dirblock.append
 
1180
        for name in sorted(_listdir(top)):
 
1181
            abspath = top_slash + name
 
1182
            statvalue = _lstat(abspath)
 
1183
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1184
            append((relprefix + name, name, kind, statvalue, abspath))
 
1185
        yield (relroot, top), dirblock
 
1186
 
 
1187
        # push the user specified dirs from dirblock
 
1188
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1189
 
 
1190
 
 
1191
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1192
    """See _walkdirs_utf8
 
1193
 
 
1194
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1195
    Unicode paths.
 
1196
    This is currently the fallback code path when the filesystem encoding is
 
1197
    not UTF-8. It may be better to implement an alternative so that we can
 
1198
    safely handle paths that are not properly decodable in the current
 
1199
    encoding.
 
1200
    """
 
1201
    _utf8_encode = codecs.getencoder('utf8')
 
1202
    _lstat = os.lstat
 
1203
    _directory = _directory_kind
 
1204
    _listdir = os.listdir
 
1205
    _kind_from_mode = _formats.get
 
1206
 
 
1207
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1208
    while pending:
 
1209
        relroot, _, _, _, top = pending.pop()
 
1210
        if relroot:
 
1211
            relprefix = relroot + '/'
 
1212
        else:
 
1213
            relprefix = ''
 
1214
        top_slash = top + u'/'
 
1215
 
 
1216
        dirblock = []
 
1217
        append = dirblock.append
 
1218
        for name in sorted(_listdir(top)):
 
1219
            name_utf8 = _utf8_encode(name)[0]
 
1220
            abspath = top_slash + name
 
1221
            statvalue = _lstat(abspath)
 
1222
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1223
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1224
        yield (relroot, top), dirblock
 
1225
 
 
1226
        # push the user specified dirs from dirblock
 
1227
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1228
 
 
1229
 
 
1230
def copy_tree(from_path, to_path, handlers={}):
 
1231
    """Copy all of the entries in from_path into to_path.
 
1232
 
 
1233
    :param from_path: The base directory to copy. 
 
1234
    :param to_path: The target directory. If it does not exist, it will
 
1235
        be created.
 
1236
    :param handlers: A dictionary of functions, which takes a source and
 
1237
        destinations for files, directories, etc.
 
1238
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1239
        'file', 'directory', and 'symlink' should always exist.
 
1240
        If they are missing, they will be replaced with 'os.mkdir()',
 
1241
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1242
    """
 
1243
    # Now, just copy the existing cached tree to the new location
 
1244
    # We use a cheap trick here.
 
1245
    # Absolute paths are prefixed with the first parameter
 
1246
    # relative paths are prefixed with the second.
 
1247
    # So we can get both the source and target returned
 
1248
    # without any extra work.
 
1249
 
 
1250
    def copy_dir(source, dest):
 
1251
        os.mkdir(dest)
 
1252
 
 
1253
    def copy_link(source, dest):
 
1254
        """Copy the contents of a symlink"""
 
1255
        link_to = os.readlink(source)
 
1256
        os.symlink(link_to, dest)
 
1257
 
 
1258
    real_handlers = {'file':shutil.copy2,
 
1259
                     'symlink':copy_link,
 
1260
                     'directory':copy_dir,
 
1261
                    }
 
1262
    real_handlers.update(handlers)
 
1263
 
 
1264
    if not os.path.exists(to_path):
 
1265
        real_handlers['directory'](from_path, to_path)
 
1266
 
 
1267
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1268
        for relpath, name, kind, st, abspath in entries:
 
1269
            real_handlers[kind](abspath, relpath)
 
1270
 
 
1271
 
 
1272
def path_prefix_key(path):
 
1273
    """Generate a prefix-order path key for path.
 
1274
 
 
1275
    This can be used to sort paths in the same way that walkdirs does.
 
1276
    """
 
1277
    return (dirname(path) , path)
 
1278
 
 
1279
 
 
1280
def compare_paths_prefix_order(path_a, path_b):
 
1281
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1282
    key_a = path_prefix_key(path_a)
 
1283
    key_b = path_prefix_key(path_b)
 
1284
    return cmp(key_a, key_b)
 
1285
 
 
1286
 
 
1287
_cached_user_encoding = None
 
1288
 
 
1289
 
 
1290
def get_user_encoding(use_cache=True):
 
1291
    """Find out what the preferred user encoding is.
 
1292
 
 
1293
    This is generally the encoding that is used for command line parameters
 
1294
    and file contents. This may be different from the terminal encoding
 
1295
    or the filesystem encoding.
 
1296
 
 
1297
    :param  use_cache:  Enable cache for detected encoding.
 
1298
                        (This parameter is turned on by default,
 
1299
                        and required only for selftesting)
 
1300
 
 
1301
    :return: A string defining the preferred user encoding
 
1302
    """
 
1303
    global _cached_user_encoding
 
1304
    if _cached_user_encoding is not None and use_cache:
 
1305
        return _cached_user_encoding
 
1306
 
 
1307
    if sys.platform == 'darwin':
 
1308
        # work around egregious python 2.4 bug
 
1309
        sys.platform = 'posix'
 
1310
        try:
 
1311
            import locale
 
1312
        finally:
 
1313
            sys.platform = 'darwin'
 
1314
    else:
 
1315
        import locale
 
1316
 
 
1317
    try:
 
1318
        user_encoding = locale.getpreferredencoding()
 
1319
    except locale.Error, e:
 
1320
        sys.stderr.write('bzr: warning: %s\n'
 
1321
                         '  Could not determine what text encoding to use.\n'
 
1322
                         '  This error usually means your Python interpreter\n'
 
1323
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1324
                         "  Continuing with ascii encoding.\n"
 
1325
                         % (e, os.environ.get('LANG')))
 
1326
        user_encoding = 'ascii'
 
1327
 
 
1328
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1329
    # treat that as ASCII, and not support printing unicode characters to the
 
1330
    # console.
 
1331
    if user_encoding in (None, 'cp0'):
 
1332
        user_encoding = 'ascii'
 
1333
    else:
 
1334
        # check encoding
 
1335
        try:
 
1336
            codecs.lookup(user_encoding)
 
1337
        except LookupError:
 
1338
            sys.stderr.write('bzr: warning:'
 
1339
                             ' unknown encoding %s.'
 
1340
                             ' Continuing with ascii encoding.\n'
 
1341
                             % user_encoding
 
1342
                            )
 
1343
            user_encoding = 'ascii'
 
1344
 
 
1345
    if use_cache:
 
1346
        _cached_user_encoding = user_encoding
 
1347
 
 
1348
    return user_encoding
 
1349
 
 
1350
 
 
1351
def recv_all(socket, bytes):
 
1352
    """Receive an exact number of bytes.
 
1353
 
 
1354
    Regular Socket.recv() may return less than the requested number of bytes,
 
1355
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1356
    on all platforms, but this should work everywhere.  This will return
 
1357
    less than the requested amount if the remote end closes.
 
1358
 
 
1359
    This isn't optimized and is intended mostly for use in testing.
 
1360
    """
 
1361
    b = ''
 
1362
    while len(b) < bytes:
 
1363
        new = socket.recv(bytes - len(b))
 
1364
        if new == '':
 
1365
            break # eof
 
1366
        b += new
 
1367
    return b
 
1368
 
 
1369
def dereference_path(path):
 
1370
    """Determine the real path to a file.
 
1371
 
 
1372
    All parent elements are dereferenced.  But the file itself is not
 
1373
    dereferenced.
 
1374
    :param path: The original path.  May be absolute or relative.
 
1375
    :return: the real path *to* the file
 
1376
    """
 
1377
    parent, base = os.path.split(path)
 
1378
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1379
    # (initial path components aren't dereferenced)
 
1380
    return pathjoin(realpath(pathjoin('.', parent)), base)