/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: Canonical.com Patch Queue Manager
  • Date: 2006-12-08 10:01:38 UTC
  • mfrom: (2162.2.8 win32.unc-path)
  • Revision ID: pqm@pqm.ubuntu.com-20061208100138-33b6d8665ca29dad
(bialix) support for win32 UNC path (bug #57869)

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