← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jonathan Lange
  • Date: 2007-04-23 01:30:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2446.
  • Revision ID: jml@canonical.com-20070423013035-zuqiamuro8h1hba9
Can also set the bug config options in branch.conf

Show diffs side-by-side

added added

removed removed

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