/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Aaron Bentley
  • Date: 2007-01-17 15:39:21 UTC
  • mfrom: (1551.9.35 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2239.
  • Revision ID: abentley@panoramicfeedback.com-20070117153921-6pp9ssa2r8n5izoo
Merge bzr.ab, to avoid conflicts submitting

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 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
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
 
from shutil import copyfile
 
17
from cStringIO import StringIO
 
18
import os
 
19
import re
 
20
import stat
20
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
 
from cStringIO import StringIO
 
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
23
30
import errno
24
 
import os
25
 
import re
 
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
26
38
import sha
 
39
import shutil
 
40
from shutil import (
 
41
    rmtree,
 
42
    )
27
43
import string
28
 
import sys
29
 
import time
30
 
import types
31
44
import tempfile
 
45
from tempfile import (
 
46
    mkdtemp,
 
47
    )
 
48
import unicodedata
 
49
 
 
50
from bzrlib import (
 
51
    errors,
 
52
    )
 
53
""")
32
54
 
33
55
import bzrlib
34
 
from bzrlib.errors import (BzrError,
35
 
                           BzrBadParameterNotUnicode,
36
 
                           NoSuchFile,
37
 
                           PathNotChild,
38
 
                           )
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    zero_nine,
 
59
    )
39
60
from bzrlib.trace import mutter
40
61
 
41
62
 
 
63
# On win32, O_BINARY is used to indicate the file should
 
64
# be opened in binary mode, rather than text mode.
 
65
# On other platforms, O_BINARY doesn't exist, because
 
66
# they always open in binary mode, so it is okay to
 
67
# OR with 0 on those platforms
 
68
O_BINARY = getattr(os, 'O_BINARY', 0)
 
69
 
 
70
 
42
71
def make_readonly(filename):
43
72
    """Make a filename read-only."""
44
73
    mod = os.stat(filename).st_mode
62
91
    Windows."""
63
92
    # TODO: I'm not really sure this is the best format either.x
64
93
    global _QUOTE_RE
65
 
    if _QUOTE_RE == None:
 
94
    if _QUOTE_RE is None:
66
95
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
67
96
        
68
97
    if _QUOTE_RE.search(f):
71
100
        return f
72
101
 
73
102
 
74
 
def file_kind(f):
75
 
    mode = os.lstat(f)[ST_MODE]
76
 
    if S_ISREG(mode):
77
 
        return 'file'
78
 
    elif S_ISDIR(mode):
79
 
        return 'directory'
80
 
    elif S_ISLNK(mode):
81
 
        return 'symlink'
82
 
    elif S_ISCHR(mode):
83
 
        return 'chardev'
84
 
    elif S_ISBLK(mode):
85
 
        return 'block'
86
 
    elif S_ISFIFO(mode):
87
 
        return 'fifo'
88
 
    elif S_ISSOCK(mode):
89
 
        return 'socket'
90
 
    else:
91
 
        return 'unknown'
 
103
_directory_kind = 'directory'
 
104
 
 
105
_formats = {
 
106
    stat.S_IFDIR:_directory_kind,
 
107
    stat.S_IFCHR:'chardev',
 
108
    stat.S_IFBLK:'block',
 
109
    stat.S_IFREG:'file',
 
110
    stat.S_IFIFO:'fifo',
 
111
    stat.S_IFLNK:'symlink',
 
112
    stat.S_IFSOCK:'socket',
 
113
}
 
114
 
 
115
 
 
116
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
117
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
118
 
 
119
    Its performance is critical: Do not mutate without careful benchmarking.
 
120
    """
 
121
    try:
 
122
        return _formats[stat_mode & 0170000]
 
123
    except KeyError:
 
124
        return _unknown
 
125
 
 
126
 
 
127
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
128
    try:
 
129
        return _mapper(_lstat(f).st_mode)
 
130
    except OSError, e:
 
131
        if getattr(e, 'errno', None) == errno.ENOENT:
 
132
            raise errors.NoSuchFile(f)
 
133
        raise
 
134
 
 
135
 
 
136
def get_umask():
 
137
    """Return the current umask"""
 
138
    # Assume that people aren't messing with the umask while running
 
139
    # XXX: This is not thread safe, but there is no way to get the
 
140
    #      umask without setting it
 
141
    umask = os.umask(0)
 
142
    os.umask(umask)
 
143
    return umask
92
144
 
93
145
 
94
146
def kind_marker(kind):
95
147
    if kind == 'file':
96
148
        return ''
97
 
    elif kind == 'directory':
 
149
    elif kind == _directory_kind:
98
150
        return '/'
99
151
    elif kind == 'symlink':
100
152
        return '@'
101
153
    else:
102
 
        raise BzrError('invalid file kind %r' % kind)
103
 
 
104
 
def lexists(f):
105
 
    if hasattr(os.path, 'lexists'):
106
 
        return os.path.lexists(f)
107
 
    try:
108
 
        if hasattr(os, 'lstat'):
109
 
            os.lstat(f)
110
 
        else:
111
 
            os.stat(f)
112
 
        return True
113
 
    except OSError,e:
114
 
        if e.errno == errno.ENOENT:
115
 
            return False;
116
 
        else:
117
 
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
154
        raise errors.BzrError('invalid file kind %r' % kind)
 
155
 
 
156
lexists = getattr(os.path, 'lexists', None)
 
157
if lexists is None:
 
158
    def lexists(f):
 
159
        try:
 
160
            if getattr(os, 'lstat') is not None:
 
161
                os.lstat(f)
 
162
            else:
 
163
                os.stat(f)
 
164
            return True
 
165
        except OSError,e:
 
166
            if e.errno == errno.ENOENT:
 
167
                return False;
 
168
            else:
 
169
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
170
 
118
171
 
119
172
def fancy_rename(old, new, rename_func, unlink_func):
120
173
    """A fancy rename, when you don't have atomic rename.
140
193
    file_existed = False
141
194
    try:
142
195
        rename_func(new, tmp_name)
143
 
    except (NoSuchFile,), e:
 
196
    except (errors.NoSuchFile,), e:
144
197
        pass
145
198
    except IOError, e:
146
199
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
 
        # function raises an IOError with errno == None when a rename fails.
 
200
        # function raises an IOError with errno is None when a rename fails.
148
201
        # This then gets caught here.
149
202
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
150
203
            raise
151
204
    except Exception, e:
152
 
        if (not hasattr(e, 'errno') 
 
205
        if (getattr(e, 'errno', None) is None
153
206
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
154
207
            raise
155
208
    else:
170
223
            else:
171
224
                rename_func(tmp_name, new)
172
225
 
173
 
# Default is to just use the python builtins
174
 
abspath = os.path.abspath
175
 
realpath = os.path.realpath
 
226
 
 
227
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
228
# choke on a Unicode string containing a relative path if
 
229
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
230
# string.
 
231
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
232
def _posix_abspath(path):
 
233
    # jam 20060426 rather than encoding to fsencoding
 
234
    # copy posixpath.abspath, but use os.getcwdu instead
 
235
    if not posixpath.isabs(path):
 
236
        path = posixpath.join(getcwd(), path)
 
237
    return posixpath.normpath(path)
 
238
 
 
239
 
 
240
def _posix_realpath(path):
 
241
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
242
 
 
243
 
 
244
def _win32_fixdrive(path):
 
245
    """Force drive letters to be consistent.
 
246
 
 
247
    win32 is inconsistent whether it returns lower or upper case
 
248
    and even if it was consistent the user might type the other
 
249
    so we force it to uppercase
 
250
    running python.exe under cmd.exe return capital C:\\
 
251
    running win32 python inside a cygwin shell returns lowercase c:\\
 
252
    """
 
253
    drive, path = _nt_splitdrive(path)
 
254
    return drive.upper() + path
 
255
 
 
256
 
 
257
def _win32_abspath(path):
 
258
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
259
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
260
 
 
261
 
 
262
def _win32_realpath(path):
 
263
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
264
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
265
 
 
266
 
 
267
def _win32_pathjoin(*args):
 
268
    return _nt_join(*args).replace('\\', '/')
 
269
 
 
270
 
 
271
def _win32_normpath(path):
 
272
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
273
 
 
274
 
 
275
def _win32_getcwd():
 
276
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
277
 
 
278
 
 
279
def _win32_mkdtemp(*args, **kwargs):
 
280
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
281
 
 
282
 
 
283
def _win32_rename(old, new):
 
284
    """We expect to be able to atomically replace 'new' with old.
 
285
 
 
286
    On win32, if new exists, it must be moved out of the way first,
 
287
    and then deleted. 
 
288
    """
 
289
    try:
 
290
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
291
    except OSError, e:
 
292
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
293
            # If we try to rename a non-existant file onto cwd, we get 
 
294
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
295
            # if the old path doesn't exist, sometimes we get EACCES
 
296
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
297
            os.lstat(old)
 
298
        raise
 
299
 
 
300
 
 
301
def _mac_getcwd():
 
302
    return unicodedata.normalize('NFKC', os.getcwdu())
 
303
 
 
304
 
 
305
# Default is to just use the python builtins, but these can be rebound on
 
306
# particular platforms.
 
307
abspath = _posix_abspath
 
308
realpath = _posix_realpath
176
309
pathjoin = os.path.join
177
310
normpath = os.path.normpath
178
311
getcwd = os.getcwdu
179
 
mkdtemp = tempfile.mkdtemp
180
312
rename = os.rename
181
313
dirname = os.path.dirname
182
314
basename = os.path.basename
183
 
 
184
 
if os.name == "posix":
185
 
    # In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
 
    # choke on a Unicode string containing a relative path if
187
 
    # os.getcwd() returns a non-sys.getdefaultencoding()-encoded
188
 
    # string.
189
 
    _fs_enc = sys.getfilesystemencoding()
190
 
    def abspath(path):
191
 
        return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
192
 
 
193
 
    def realpath(path):
194
 
        return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
315
split = os.path.split
 
316
splitext = os.path.splitext
 
317
# These were already imported into local scope
 
318
# mkdtemp = tempfile.mkdtemp
 
319
# rmtree = shutil.rmtree
 
320
 
 
321
MIN_ABS_PATHLENGTH = 1
 
322
 
195
323
 
196
324
if sys.platform == 'win32':
197
 
    # We need to use the Unicode-aware os.path.abspath and
198
 
    # os.path.realpath on Windows systems.
199
 
    def abspath(path):
200
 
        return os.path.abspath(path).replace('\\', '/')
201
 
 
202
 
    def realpath(path):
203
 
        return os.path.realpath(path).replace('\\', '/')
204
 
 
205
 
    def pathjoin(*args):
206
 
        return os.path.join(*args).replace('\\', '/')
207
 
 
208
 
    def normpath(path):
209
 
        return os.path.normpath(path).replace('\\', '/')
210
 
 
211
 
    def getcwd():
212
 
        return os.getcwdu().replace('\\', '/')
213
 
 
214
 
    def mkdtemp(*args, **kwargs):
215
 
        return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
216
 
 
217
 
    def rename(old, new):
218
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
325
    abspath = _win32_abspath
 
326
    realpath = _win32_realpath
 
327
    pathjoin = _win32_pathjoin
 
328
    normpath = _win32_normpath
 
329
    getcwd = _win32_getcwd
 
330
    mkdtemp = _win32_mkdtemp
 
331
    rename = _win32_rename
 
332
 
 
333
    MIN_ABS_PATHLENGTH = 3
 
334
 
 
335
    def _win32_delete_readonly(function, path, excinfo):
 
336
        """Error handler for shutil.rmtree function [for win32]
 
337
        Helps to remove files and dirs marked as read-only.
 
338
        """
 
339
        exception = excinfo[1]
 
340
        if function in (os.remove, os.rmdir) \
 
341
            and isinstance(exception, OSError) \
 
342
            and exception.errno == errno.EACCES:
 
343
            make_writable(path)
 
344
            function(path)
 
345
        else:
 
346
            raise
 
347
 
 
348
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
349
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
350
        return shutil.rmtree(path, ignore_errors, onerror)
 
351
elif sys.platform == 'darwin':
 
352
    getcwd = _mac_getcwd
 
353
 
 
354
 
 
355
def get_terminal_encoding():
 
356
    """Find the best encoding for printing to the screen.
 
357
 
 
358
    This attempts to check both sys.stdout and sys.stdin to see
 
359
    what encoding they are in, and if that fails it falls back to
 
360
    bzrlib.user_encoding.
 
361
    The problem is that on Windows, locale.getpreferredencoding()
 
362
    is not the same encoding as that used by the console:
 
363
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
364
 
 
365
    On my standard US Windows XP, the preferred encoding is
 
366
    cp1252, but the console is cp437
 
367
    """
 
368
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
369
    if not output_encoding:
 
370
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
371
        if not input_encoding:
 
372
            output_encoding = bzrlib.user_encoding
 
373
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
374
        else:
 
375
            output_encoding = input_encoding
 
376
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
377
    else:
 
378
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
379
    if output_encoding == 'cp0':
 
380
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
381
        output_encoding = bzrlib.user_encoding
 
382
        mutter('cp0 is invalid encoding.'
 
383
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
384
    # check encoding
 
385
    try:
 
386
        codecs.lookup(output_encoding)
 
387
    except LookupError:
 
388
        sys.stderr.write('bzr: warning:'
 
389
                         ' unknown terminal encoding %s.\n'
 
390
                         '  Using encoding %s instead.\n'
 
391
                         % (output_encoding, bzrlib.user_encoding)
 
392
                        )
 
393
        output_encoding = bzrlib.user_encoding
 
394
 
 
395
    return output_encoding
219
396
 
220
397
 
221
398
def normalizepath(f):
222
 
    if hasattr(os.path, 'realpath'):
 
399
    if getattr(os.path, 'realpath', None) is not None:
223
400
        F = realpath
224
401
    else:
225
402
        F = abspath
289
466
    
290
467
    The empty string as a dir name is taken as top-of-tree and matches 
291
468
    everything.
292
 
    
293
 
    >>> is_inside('src', pathjoin('src', 'foo.c'))
294
 
    True
295
 
    >>> is_inside('src', 'srccontrol')
296
 
    False
297
 
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
298
 
    True
299
 
    >>> is_inside('foo.c', 'foo.c')
300
 
    True
301
 
    >>> is_inside('foo.c', '')
302
 
    False
303
 
    >>> is_inside('', 'foo.c')
304
 
    True
305
469
    """
306
470
    # XXX: Most callers of this can actually do something smarter by 
307
471
    # looking at the inventory
326
490
        return False
327
491
 
328
492
 
 
493
def is_inside_or_parent_of_any(dir_list, fname):
 
494
    """True if fname is a child or a parent of any of the given files."""
 
495
    for dirname in dir_list:
 
496
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
497
            return True
 
498
    else:
 
499
        return False
 
500
 
 
501
 
329
502
def pumpfile(fromfile, tofile):
330
503
    """Copy contents of one file to another."""
331
504
    BUFSIZE = 32768
345
518
 
346
519
 
347
520
def sha_file(f):
348
 
    if hasattr(f, 'tell'):
 
521
    if getattr(f, 'tell', None) is not None:
349
522
        assert f.tell() == 0
350
523
    s = sha.new()
351
524
    BUFSIZE = 128<<10
394
567
 
395
568
def local_time_offset(t=None):
396
569
    """Return offset of local zone from GMT, either at present or at time t."""
397
 
    # python2.3 localtime() can't take None
398
 
    if t == None:
 
570
    if t is None:
399
571
        t = time.time()
400
 
        
401
 
    if time.localtime(t).tm_isdst and time.daylight:
402
 
        return -time.altzone
403
 
    else:
404
 
        return -time.timezone
 
572
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
573
    return offset.days * 86400 + offset.seconds
405
574
 
406
575
    
407
576
def format_date(t, offset=0, timezone='original', date_fmt=None, 
414
583
        tt = time.gmtime(t)
415
584
        offset = 0
416
585
    elif timezone == 'original':
417
 
        if offset == None:
 
586
        if offset is None:
418
587
            offset = 0
419
588
        tt = time.gmtime(t + offset)
420
589
    elif timezone == 'local':
421
590
        tt = time.localtime(t)
422
591
        offset = local_time_offset(t)
423
592
    else:
424
 
        raise BzrError("unsupported timezone format %r" % timezone,
425
 
                       ['options are "utc", "original", "local"'])
 
593
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
594
                              ['options are "utc", "original", "local"'])
426
595
    if date_fmt is None:
427
596
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
428
597
    if show_offset:
436
605
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
437
606
    
438
607
 
 
608
def format_delta(delta):
 
609
    """Get a nice looking string for a time delta.
 
610
 
 
611
    :param delta: The time difference in seconds, can be positive or negative.
 
612
        positive indicates time in the past, negative indicates time in the
 
613
        future. (usually time.time() - stored_time)
 
614
    :return: String formatted to show approximate resolution
 
615
    """
 
616
    delta = int(delta)
 
617
    if delta >= 0:
 
618
        direction = 'ago'
 
619
    else:
 
620
        direction = 'in the future'
 
621
        delta = -delta
 
622
 
 
623
    seconds = delta
 
624
    if seconds < 90: # print seconds up to 90 seconds
 
625
        if seconds == 1:
 
626
            return '%d second %s' % (seconds, direction,)
 
627
        else:
 
628
            return '%d seconds %s' % (seconds, direction)
 
629
 
 
630
    minutes = int(seconds / 60)
 
631
    seconds -= 60 * minutes
 
632
    if seconds == 1:
 
633
        plural_seconds = ''
 
634
    else:
 
635
        plural_seconds = 's'
 
636
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
637
        if minutes == 1:
 
638
            return '%d minute, %d second%s %s' % (
 
639
                    minutes, seconds, plural_seconds, direction)
 
640
        else:
 
641
            return '%d minutes, %d second%s %s' % (
 
642
                    minutes, seconds, plural_seconds, direction)
 
643
 
 
644
    hours = int(minutes / 60)
 
645
    minutes -= 60 * hours
 
646
    if minutes == 1:
 
647
        plural_minutes = ''
 
648
    else:
 
649
        plural_minutes = 's'
 
650
 
 
651
    if hours == 1:
 
652
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
653
                                            plural_minutes, direction)
 
654
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
655
                                         plural_minutes, direction)
439
656
 
440
657
def filesize(f):
441
658
    """Return size of given open file."""
451
668
except (NotImplementedError, AttributeError):
452
669
    # If python doesn't have os.urandom, or it doesn't work,
453
670
    # then try to first pull random data from /dev/urandom
454
 
    if os.path.exists("/dev/urandom"):
 
671
    try:
455
672
        rand_bytes = file('/dev/urandom', 'rb').read
456
673
    # Otherwise, use this hack as a last resort
457
 
    else:
 
674
    except (IOError, OSError):
458
675
        # not well seeded, but better than nothing
459
676
        def rand_bytes(n):
460
677
            import random
482
699
## decomposition (might be too tricksy though.)
483
700
 
484
701
def splitpath(p):
485
 
    """Turn string into list of parts.
486
 
 
487
 
    >>> splitpath('a')
488
 
    ['a']
489
 
    >>> splitpath('a/b')
490
 
    ['a', 'b']
491
 
    >>> splitpath('a/./b')
492
 
    ['a', 'b']
493
 
    >>> splitpath('a/.b')
494
 
    ['a', '.b']
495
 
    >>> splitpath('a/../b')
496
 
    Traceback (most recent call last):
497
 
    ...
498
 
    BzrError: sorry, '..' not allowed in path
499
 
    """
500
 
    assert isinstance(p, types.StringTypes)
 
702
    """Turn string into list of parts."""
 
703
    assert isinstance(p, basestring)
501
704
 
502
705
    # split on either delimiter because people might use either on
503
706
    # Windows
506
709
    rps = []
507
710
    for f in ps:
508
711
        if f == '..':
509
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
712
            raise errors.BzrError("sorry, %r not allowed in path" % f)
510
713
        elif (f == '.') or (f == ''):
511
714
            pass
512
715
        else:
516
719
def joinpath(p):
517
720
    assert isinstance(p, list)
518
721
    for f in p:
519
 
        if (f == '..') or (f == None) or (f == ''):
520
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
722
        if (f == '..') or (f is None) or (f == ''):
 
723
            raise errors.BzrError("sorry, %r not allowed in path" % f)
521
724
    return pathjoin(*p)
522
725
 
523
726
 
 
727
@deprecated_function(zero_nine)
524
728
def appendpath(p1, p2):
525
729
    if p1 == '':
526
730
        return p2
530
734
 
531
735
def split_lines(s):
532
736
    """Split s into lines, but without removing the newline characters."""
533
 
    return StringIO(s).readlines()
 
737
    lines = s.split('\n')
 
738
    result = [line + '\n' for line in lines[:-1]]
 
739
    if lines[-1]:
 
740
        result.append(lines[-1])
 
741
    return result
534
742
 
535
743
 
536
744
def hardlinks_good():
540
748
def link_or_copy(src, dest):
541
749
    """Hardlink a file, or copy it if it can't be hardlinked."""
542
750
    if not hardlinks_good():
543
 
        copyfile(src, dest)
 
751
        shutil.copyfile(src, dest)
544
752
        return
545
753
    try:
546
754
        os.link(src, dest)
547
755
    except (OSError, IOError), e:
548
756
        if e.errno != errno.EXDEV:
549
757
            raise
550
 
        copyfile(src, dest)
 
758
        shutil.copyfile(src, dest)
551
759
 
552
760
def delete_any(full_path):
553
761
    """Delete a file or directory."""
561
769
 
562
770
 
563
771
def has_symlinks():
564
 
    if hasattr(os, 'symlink'):
 
772
    if getattr(os, 'symlink', None) is not None:
565
773
        return True
566
774
    else:
567
775
        return False
595
803
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
596
804
    avoids that problem.
597
805
    """
598
 
    if sys.platform != "win32":
599
 
        minlength = 1
600
 
    else:
601
 
        minlength = 3
602
 
    assert len(base) >= minlength, ('Length of base must be equal or exceed the'
603
 
        ' platform minimum length (which is %d)' % minlength)
 
806
 
 
807
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
808
        ' exceed the platform minimum length (which is %d)' % 
 
809
        MIN_ABS_PATHLENGTH)
 
810
 
604
811
    rp = abspath(path)
605
812
 
606
813
    s = []
612
819
        if tail:
613
820
            s.insert(0, tail)
614
821
    else:
615
 
        # XXX This should raise a NotChildPath exception, as its not tied
616
 
        # to branch anymore.
617
 
        raise PathNotChild(rp, base)
 
822
        raise errors.PathNotChild(rp, base)
618
823
 
619
824
    if s:
620
825
        return pathjoin(*s)
635
840
    try:
636
841
        return unicode_or_utf8_string.decode('utf8')
637
842
    except UnicodeDecodeError:
638
 
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
843
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
844
 
 
845
 
 
846
_platform_normalizes_filenames = False
 
847
if sys.platform == 'darwin':
 
848
    _platform_normalizes_filenames = True
 
849
 
 
850
 
 
851
def normalizes_filenames():
 
852
    """Return True if this platform normalizes unicode filenames.
 
853
 
 
854
    Mac OSX does, Windows/Linux do not.
 
855
    """
 
856
    return _platform_normalizes_filenames
 
857
 
 
858
 
 
859
def _accessible_normalized_filename(path):
 
860
    """Get the unicode normalized path, and if you can access the file.
 
861
 
 
862
    On platforms where the system normalizes filenames (Mac OSX),
 
863
    you can access a file by any path which will normalize correctly.
 
864
    On platforms where the system does not normalize filenames 
 
865
    (Windows, Linux), you have to access a file by its exact path.
 
866
 
 
867
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
868
    the standard for XML documents.
 
869
 
 
870
    So return the normalized path, and a flag indicating if the file
 
871
    can be accessed by that path.
 
872
    """
 
873
 
 
874
    return unicodedata.normalize('NFKC', unicode(path)), True
 
875
 
 
876
 
 
877
def _inaccessible_normalized_filename(path):
 
878
    __doc__ = _accessible_normalized_filename.__doc__
 
879
 
 
880
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
881
    return normalized, normalized == path
 
882
 
 
883
 
 
884
if _platform_normalizes_filenames:
 
885
    normalized_filename = _accessible_normalized_filename
 
886
else:
 
887
    normalized_filename = _inaccessible_normalized_filename
639
888
 
640
889
 
641
890
def terminal_width():
642
891
    """Return estimated terminal width."""
643
 
 
644
 
    # TODO: Do something smart on Windows?
645
 
 
646
 
    # TODO: Is there anything that gets a better update when the window
647
 
    # is resized while the program is running? We could use the Python termcap
648
 
    # library.
 
892
    if sys.platform == 'win32':
 
893
        import bzrlib.win32console
 
894
        return bzrlib.win32console.get_console_size()[0]
 
895
    width = 0
649
896
    try:
650
 
        return int(os.environ['COLUMNS'])
651
 
    except (IndexError, KeyError, ValueError):
652
 
        return 80
 
897
        import struct, fcntl, termios
 
898
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
899
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
900
        width = struct.unpack('HHHH', x)[1]
 
901
    except IOError:
 
902
        pass
 
903
    if width <= 0:
 
904
        try:
 
905
            width = int(os.environ['COLUMNS'])
 
906
        except:
 
907
            pass
 
908
    if width <= 0:
 
909
        width = 80
 
910
 
 
911
    return width
 
912
 
653
913
 
654
914
def supports_executable():
655
915
    return sys.platform != "win32"
 
916
 
 
917
 
 
918
def set_or_unset_env(env_variable, value):
 
919
    """Modify the environment, setting or removing the env_variable.
 
920
 
 
921
    :param env_variable: The environment variable in question
 
922
    :param value: The value to set the environment to. If None, then
 
923
        the variable will be removed.
 
924
    :return: The original value of the environment variable.
 
925
    """
 
926
    orig_val = os.environ.get(env_variable)
 
927
    if value is None:
 
928
        if orig_val is not None:
 
929
            del os.environ[env_variable]
 
930
    else:
 
931
        if isinstance(value, unicode):
 
932
            value = value.encode(bzrlib.user_encoding)
 
933
        os.environ[env_variable] = value
 
934
    return orig_val
 
935
 
 
936
 
 
937
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
938
 
 
939
 
 
940
def check_legal_path(path):
 
941
    """Check whether the supplied path is legal.  
 
942
    This is only required on Windows, so we don't test on other platforms
 
943
    right now.
 
944
    """
 
945
    if sys.platform != "win32":
 
946
        return
 
947
    if _validWin32PathRE.match(path) is None:
 
948
        raise errors.IllegalPath(path)
 
949
 
 
950
 
 
951
def walkdirs(top, prefix=""):
 
952
    """Yield data about all the directories in a tree.
 
953
    
 
954
    This yields all the data about the contents of a directory at a time.
 
955
    After each directory has been yielded, if the caller has mutated the list
 
956
    to exclude some directories, they are then not descended into.
 
957
    
 
958
    The data yielded is of the form:
 
959
    ((directory-relpath, directory-path-from-top),
 
960
    [(relpath, basename, kind, lstat), ...]),
 
961
     - directory-relpath is the relative path of the directory being returned
 
962
       with respect to top. prefix is prepended to this.
 
963
     - directory-path-from-root is the path including top for this directory. 
 
964
       It is suitable for use with os functions.
 
965
     - relpath is the relative path within the subtree being walked.
 
966
     - basename is the basename of the path
 
967
     - kind is the kind of the file now. If unknown then the file is not
 
968
       present within the tree - but it may be recorded as versioned. See
 
969
       versioned_kind.
 
970
     - lstat is the stat data *if* the file was statted.
 
971
     - planned, not implemented: 
 
972
       path_from_tree_root is the path from the root of the tree.
 
973
 
 
974
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
975
        allows one to walk a subtree but get paths that are relative to a tree
 
976
        rooted higher up.
 
977
    :return: an iterator over the dirs.
 
978
    """
 
979
    #TODO there is a bit of a smell where the results of the directory-
 
980
    # summary in this, and the path from the root, may not agree 
 
981
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
982
    # potentially confusing output. We should make this more robust - but
 
983
    # not at a speed cost. RBC 20060731
 
984
    lstat = os.lstat
 
985
    pending = []
 
986
    _directory = _directory_kind
 
987
    _listdir = os.listdir
 
988
    pending = [(prefix, "", _directory, None, top)]
 
989
    while pending:
 
990
        dirblock = []
 
991
        currentdir = pending.pop()
 
992
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
993
        top = currentdir[4]
 
994
        if currentdir[0]:
 
995
            relroot = currentdir[0] + '/'
 
996
        else:
 
997
            relroot = ""
 
998
        for name in sorted(_listdir(top)):
 
999
            abspath = top + '/' + name
 
1000
            statvalue = lstat(abspath)
 
1001
            dirblock.append((relroot + name, name,
 
1002
                file_kind_from_stat_mode(statvalue.st_mode),
 
1003
                statvalue, abspath))
 
1004
        yield (currentdir[0], top), dirblock
 
1005
        # push the user specified dirs from dirblock
 
1006
        for dir in reversed(dirblock):
 
1007
            if dir[2] == _directory:
 
1008
                pending.append(dir)
 
1009
 
 
1010
 
 
1011
def copy_tree(from_path, to_path, handlers={}):
 
1012
    """Copy all of the entries in from_path into to_path.
 
1013
 
 
1014
    :param from_path: The base directory to copy. 
 
1015
    :param to_path: The target directory. If it does not exist, it will
 
1016
        be created.
 
1017
    :param handlers: A dictionary of functions, which takes a source and
 
1018
        destinations for files, directories, etc.
 
1019
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1020
        'file', 'directory', and 'symlink' should always exist.
 
1021
        If they are missing, they will be replaced with 'os.mkdir()',
 
1022
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1023
    """
 
1024
    # Now, just copy the existing cached tree to the new location
 
1025
    # We use a cheap trick here.
 
1026
    # Absolute paths are prefixed with the first parameter
 
1027
    # relative paths are prefixed with the second.
 
1028
    # So we can get both the source and target returned
 
1029
    # without any extra work.
 
1030
 
 
1031
    def copy_dir(source, dest):
 
1032
        os.mkdir(dest)
 
1033
 
 
1034
    def copy_link(source, dest):
 
1035
        """Copy the contents of a symlink"""
 
1036
        link_to = os.readlink(source)
 
1037
        os.symlink(link_to, dest)
 
1038
 
 
1039
    real_handlers = {'file':shutil.copy2,
 
1040
                     'symlink':copy_link,
 
1041
                     'directory':copy_dir,
 
1042
                    }
 
1043
    real_handlers.update(handlers)
 
1044
 
 
1045
    if not os.path.exists(to_path):
 
1046
        real_handlers['directory'](from_path, to_path)
 
1047
 
 
1048
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1049
        for relpath, name, kind, st, abspath in entries:
 
1050
            real_handlers[kind](abspath, relpath)
 
1051
 
 
1052
 
 
1053
def path_prefix_key(path):
 
1054
    """Generate a prefix-order path key for path.
 
1055
 
 
1056
    This can be used to sort paths in the same way that walkdirs does.
 
1057
    """
 
1058
    return (dirname(path) , path)
 
1059
 
 
1060
 
 
1061
def compare_paths_prefix_order(path_a, path_b):
 
1062
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1063
    key_a = path_prefix_key(path_a)
 
1064
    key_b = path_prefix_key(path_b)
 
1065
    return cmp(key_a, key_b)
 
1066
 
 
1067
 
 
1068
_cached_user_encoding = None
 
1069
 
 
1070
 
 
1071
def get_user_encoding(use_cache=True):
 
1072
    """Find out what the preferred user encoding is.
 
1073
 
 
1074
    This is generally the encoding that is used for command line parameters
 
1075
    and file contents. This may be different from the terminal encoding
 
1076
    or the filesystem encoding.
 
1077
 
 
1078
    :param  use_cache:  Enable cache for detected encoding.
 
1079
                        (This parameter is turned on by default,
 
1080
                        and required only for selftesting)
 
1081
 
 
1082
    :return: A string defining the preferred user encoding
 
1083
    """
 
1084
    global _cached_user_encoding
 
1085
    if _cached_user_encoding is not None and use_cache:
 
1086
        return _cached_user_encoding
 
1087
 
 
1088
    if sys.platform == 'darwin':
 
1089
        # work around egregious python 2.4 bug
 
1090
        sys.platform = 'posix'
 
1091
        try:
 
1092
            import locale
 
1093
        finally:
 
1094
            sys.platform = 'darwin'
 
1095
    else:
 
1096
        import locale
 
1097
 
 
1098
    try:
 
1099
        user_encoding = locale.getpreferredencoding()
 
1100
    except locale.Error, e:
 
1101
        sys.stderr.write('bzr: warning: %s\n'
 
1102
                         '  Could not determine what text encoding to use.\n'
 
1103
                         '  This error usually means your Python interpreter\n'
 
1104
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1105
                         "  Continuing with ascii encoding.\n"
 
1106
                         % (e, os.environ.get('LANG')))
 
1107
        user_encoding = 'ascii'
 
1108
 
 
1109
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1110
    # treat that as ASCII, and not support printing unicode characters to the
 
1111
    # console.
 
1112
    if user_encoding in (None, 'cp0'):
 
1113
        user_encoding = 'ascii'
 
1114
    else:
 
1115
        # check encoding
 
1116
        try:
 
1117
            codecs.lookup(user_encoding)
 
1118
        except LookupError:
 
1119
            sys.stderr.write('bzr: warning:'
 
1120
                             ' unknown encoding %s.'
 
1121
                             ' Continuing with ascii encoding.\n'
 
1122
                             % user_encoding
 
1123
                            )
 
1124
            user_encoding = 'ascii'
 
1125
 
 
1126
    if use_cache:
 
1127
        _cached_user_encoding = user_encoding
 
1128
 
 
1129
    return user_encoding
 
1130
 
 
1131
 
 
1132
def recv_all(socket, bytes):
 
1133
    """Receive an exact number of bytes.
 
1134
 
 
1135
    Regular Socket.recv() may return less than the requested number of bytes,
 
1136
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1137
    on all platforms, but this should work everywhere.  This will return
 
1138
    less than the requested amount if the remote end closes.
 
1139
 
 
1140
    This isn't optimized and is intended mostly for use in testing.
 
1141
    """
 
1142
    b = ''
 
1143
    while len(b) < bytes:
 
1144
        new = socket.recv(bytes - len(b))
 
1145
        if new == '':
 
1146
            break # eof
 
1147
        b += new
 
1148
    return b
 
1149
 
 
1150
def dereference_path(path):
 
1151
    """Determine the real path to a file.
 
1152
 
 
1153
    All parent elements are dereferenced.  But the file itself is not
 
1154
    dereferenced.
 
1155
    :param path: The original path.  May be absolute or relative.
 
1156
    :return: the real path *to* the file
 
1157
    """
 
1158
    parent, base = os.path.split(path)
 
1159
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1160
    # (initial path components aren't dereferenced)
 
1161
    return pathjoin(realpath(pathjoin('.', parent)), base)