← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

Merge trunk.

Show diffs side-by-side

added added

removed removed

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