~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Aaron Bentley
  • Date: 2008-03-11 14:29:08 UTC
  • mto: This revision was merged to the branch mainline in revision 3264.
  • Revision ID: aaron@aaronbentley.com-20080311142908-yyrvcpn2mldt0fnn
Update documentation to reflect conflict-handling difference

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