1
# Bazaar -- distributed version control
 
 
3
# Copyright (C) 2005 by Canonical Ltd
 
 
5
# This program is free software; you can redistribute it and/or modify
 
 
6
# it under the terms of the GNU General Public License as published by
 
 
7
# the Free Software Foundation; either version 2 of the License, or
 
 
8
# (at your option) any later version.
 
 
10
# This program is distributed in the hope that it will be useful,
 
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
13
# GNU General Public License for more details.
 
 
15
# You should have received a copy of the GNU General Public License
 
 
16
# along with this program; if not, write to the Free Software
 
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
19
from cStringIO import StringIO
 
 
21
from ntpath import (abspath as _nt_abspath,
 
 
23
                    normpath as _nt_normpath,
 
 
24
                    realpath as _nt_realpath,
 
 
25
                    splitdrive as _nt_splitdrive,
 
 
28
from os import listdir
 
 
33
from shutil import copyfile
 
 
35
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
 
36
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
 
45
from bzrlib.errors import (BzrError,
 
 
46
                           BzrBadParameterNotUnicode,
 
 
51
from bzrlib.symbol_versioning import (deprecated_function, 
 
 
53
from bzrlib.trace import mutter
 
 
56
# On win32, O_BINARY is used to indicate the file should
 
 
57
# be opened in binary mode, rather than text mode.
 
 
58
# On other platforms, O_BINARY doesn't exist, because
 
 
59
# they always open in binary mode, so it is okay to
 
 
60
# OR with 0 on those platforms
 
 
61
O_BINARY = getattr(os, 'O_BINARY', 0)
 
 
64
def make_readonly(filename):
 
 
65
    """Make a filename read-only."""
 
 
66
    mod = os.stat(filename).st_mode
 
 
68
    os.chmod(filename, mod)
 
 
71
def make_writable(filename):
 
 
72
    mod = os.stat(filename).st_mode
 
 
74
    os.chmod(filename, mod)
 
 
81
    """Return a quoted filename filename
 
 
83
    This previously used backslash quoting, but that works poorly on
 
 
85
    # TODO: I'm not really sure this is the best format either.x
 
 
88
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
 
90
    if _QUOTE_RE.search(f):
 
 
96
_directory_kind = 'directory'
 
 
99
    stat.S_IFDIR:_directory_kind,
 
 
100
    stat.S_IFCHR:'chardev',
 
 
101
    stat.S_IFBLK:'block',
 
 
104
    stat.S_IFLNK:'symlink',
 
 
105
    stat.S_IFSOCK:'socket',
 
 
109
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
 
110
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
 
112
    Its performance is critical: Do not mutate without careful benchmarking.
 
 
115
        return _formats[stat_mode & 0170000]
 
 
120
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
 
122
        return _mapper(_lstat(f).st_mode)
 
 
124
        if getattr(e, 'errno', None) == errno.ENOENT:
 
 
125
            raise bzrlib.errors.NoSuchFile(f)
 
 
130
    """Return the current umask"""
 
 
131
    # Assume that people aren't messing with the umask while running
 
 
132
    # XXX: This is not thread safe, but there is no way to get the
 
 
133
    #      umask without setting it
 
 
139
def kind_marker(kind):
 
 
142
    elif kind == _directory_kind:
 
 
144
    elif kind == 'symlink':
 
 
147
        raise BzrError('invalid file kind %r' % kind)
 
 
149
lexists = getattr(os.path, 'lexists', None)
 
 
153
            if getattr(os, 'lstat') is not None:
 
 
159
            if e.errno == errno.ENOENT:
 
 
162
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
 
165
def fancy_rename(old, new, rename_func, unlink_func):
 
 
166
    """A fancy rename, when you don't have atomic rename.
 
 
168
    :param old: The old path, to rename from
 
 
169
    :param new: The new path, to rename to
 
 
170
    :param rename_func: The potentially non-atomic rename function
 
 
171
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
 
174
    # sftp rename doesn't allow overwriting, so play tricks:
 
 
176
    base = os.path.basename(new)
 
 
177
    dirname = os.path.dirname(new)
 
 
178
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
 
179
    tmp_name = pathjoin(dirname, tmp_name)
 
 
181
    # Rename the file out of the way, but keep track if it didn't exist
 
 
182
    # We don't want to grab just any exception
 
 
183
    # something like EACCES should prevent us from continuing
 
 
184
    # The downside is that the rename_func has to throw an exception
 
 
185
    # with an errno = ENOENT, or NoSuchFile
 
 
188
        rename_func(new, tmp_name)
 
 
189
    except (NoSuchFile,), e:
 
 
192
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
 
193
        # function raises an IOError with errno is None when a rename fails.
 
 
194
        # This then gets caught here.
 
 
195
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
 
198
        if (getattr(e, 'errno', None) is None
 
 
199
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
 
206
        # This may throw an exception, in which case success will
 
 
208
        rename_func(old, new)
 
 
212
            # If the file used to exist, rename it back into place
 
 
213
            # otherwise just delete it from the tmp location
 
 
215
                unlink_func(tmp_name)
 
 
217
                rename_func(tmp_name, new)
 
 
220
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
 
221
# choke on a Unicode string containing a relative path if
 
 
222
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
 
224
_fs_enc = sys.getfilesystemencoding()
 
 
225
def _posix_abspath(path):
 
 
226
    # jam 20060426 rather than encoding to fsencoding
 
 
227
    # copy posixpath.abspath, but use os.getcwdu instead
 
 
228
    if not posixpath.isabs(path):
 
 
229
        path = posixpath.join(getcwd(), path)
 
 
230
    return posixpath.normpath(path)
 
 
233
def _posix_realpath(path):
 
 
234
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
 
237
def _win32_fixdrive(path):
 
 
238
    """Force drive letters to be consistent.
 
 
240
    win32 is inconsistent whether it returns lower or upper case
 
 
241
    and even if it was consistent the user might type the other
 
 
242
    so we force it to uppercase
 
 
243
    running python.exe under cmd.exe return capital C:\\
 
 
244
    running win32 python inside a cygwin shell returns lowercase c:\\
 
 
246
    drive, path = _nt_splitdrive(path)
 
 
247
    return drive.upper() + path
 
 
250
def _win32_abspath(path):
 
 
251
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
 
252
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
 
255
def _win32_realpath(path):
 
 
256
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
 
257
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
 
260
def _win32_pathjoin(*args):
 
 
261
    return _nt_join(*args).replace('\\', '/')
 
 
264
def _win32_normpath(path):
 
 
265
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
 
269
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
 
272
def _win32_mkdtemp(*args, **kwargs):
 
 
273
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
 
276
def _win32_rename(old, new):
 
 
277
    """We expect to be able to atomically replace 'new' with old.
 
 
279
    On win32, if new exists, it must be moved out of the way first,
 
 
283
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
 
285
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
 
286
            # If we try to rename a non-existant file onto cwd, we get 
 
 
287
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
 
288
            # if the old path doesn't exist, sometimes we get EACCES
 
 
289
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
 
295
    return unicodedata.normalize('NFKC', os.getcwdu())
 
 
298
# Default is to just use the python builtins, but these can be rebound on
 
 
299
# particular platforms.
 
 
300
abspath = _posix_abspath
 
 
301
realpath = _posix_realpath
 
 
302
pathjoin = os.path.join
 
 
303
normpath = os.path.normpath
 
 
305
mkdtemp = tempfile.mkdtemp
 
 
307
dirname = os.path.dirname
 
 
308
basename = os.path.basename
 
 
309
rmtree = shutil.rmtree
 
 
311
MIN_ABS_PATHLENGTH = 1
 
 
314
if sys.platform == 'win32':
 
 
315
    abspath = _win32_abspath
 
 
316
    realpath = _win32_realpath
 
 
317
    pathjoin = _win32_pathjoin
 
 
318
    normpath = _win32_normpath
 
 
319
    getcwd = _win32_getcwd
 
 
320
    mkdtemp = _win32_mkdtemp
 
 
321
    rename = _win32_rename
 
 
323
    MIN_ABS_PATHLENGTH = 3
 
 
325
    def _win32_delete_readonly(function, path, excinfo):
 
 
326
        """Error handler for shutil.rmtree function [for win32]
 
 
327
        Helps to remove files and dirs marked as read-only.
 
 
329
        type_, value = excinfo[:2]
 
 
330
        if function in (os.remove, os.rmdir) \
 
 
331
            and type_ == OSError \
 
 
332
            and value.errno == errno.EACCES:
 
 
333
            bzrlib.osutils.make_writable(path)
 
 
338
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
 
339
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
 
340
        return shutil.rmtree(path, ignore_errors, onerror)
 
 
341
elif sys.platform == 'darwin':
 
 
345
def get_terminal_encoding():
 
 
346
    """Find the best encoding for printing to the screen.
 
 
348
    This attempts to check both sys.stdout and sys.stdin to see
 
 
349
    what encoding they are in, and if that fails it falls back to
 
 
350
    bzrlib.user_encoding.
 
 
351
    The problem is that on Windows, locale.getpreferredencoding()
 
 
352
    is not the same encoding as that used by the console:
 
 
353
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
 
355
    On my standard US Windows XP, the preferred encoding is
 
 
356
    cp1252, but the console is cp437
 
 
358
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
 
359
    if not output_encoding:
 
 
360
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
 
361
        if not input_encoding:
 
 
362
            output_encoding = bzrlib.user_encoding
 
 
363
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
 
365
            output_encoding = input_encoding
 
 
366
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
 
368
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
 
369
    return output_encoding
 
 
372
def normalizepath(f):
 
 
373
    if getattr(os.path, 'realpath', None) is not None:
 
 
377
    [p,e] = os.path.split(f)
 
 
378
    if e == "" or e == "." or e == "..":
 
 
381
        return pathjoin(F(p), e)
 
 
385
    """Copy a file to a backup.
 
 
387
    Backups are named in GNU-style, with a ~ suffix.
 
 
389
    If the file is already a backup, it's not copied.
 
 
395
    if has_symlinks() and os.path.islink(fn):
 
 
396
        target = os.readlink(fn)
 
 
397
        os.symlink(target, bfn)
 
 
405
    outf = file(bfn, 'wb')
 
 
413
    """True if f is an accessible directory."""
 
 
415
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
 
421
    """True if f is a regular file."""
 
 
423
        return S_ISREG(os.lstat(f)[ST_MODE])
 
 
428
    """True if f is a symlink."""
 
 
430
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
 
434
def is_inside(dir, fname):
 
 
435
    """True if fname is inside dir.
 
 
437
    The parameters should typically be passed to osutils.normpath first, so
 
 
438
    that . and .. and repeated slashes are eliminated, and the separators
 
 
439
    are canonical for the platform.
 
 
441
    The empty string as a dir name is taken as top-of-tree and matches 
 
 
444
    >>> is_inside('src', pathjoin('src', 'foo.c'))
 
 
446
    >>> is_inside('src', 'srccontrol')
 
 
448
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
 
 
450
    >>> is_inside('foo.c', 'foo.c')
 
 
452
    >>> is_inside('foo.c', '')
 
 
454
    >>> is_inside('', 'foo.c')
 
 
457
    # XXX: Most callers of this can actually do something smarter by 
 
 
458
    # looking at the inventory
 
 
468
    return fname.startswith(dir)
 
 
471
def is_inside_any(dir_list, fname):
 
 
472
    """True if fname is inside any of given dirs."""
 
 
473
    for dirname in dir_list:
 
 
474
        if is_inside(dirname, fname):
 
 
480
def is_inside_or_parent_of_any(dir_list, fname):
 
 
481
    """True if fname is a child or a parent of any of the given files."""
 
 
482
    for dirname in dir_list:
 
 
483
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
 
489
def pumpfile(fromfile, tofile):
 
 
490
    """Copy contents of one file to another."""
 
 
493
        b = fromfile.read(BUFSIZE)
 
 
499
def file_iterator(input_file, readsize=32768):
 
 
501
        b = input_file.read(readsize)
 
 
508
    if getattr(f, 'tell', None) is not None:
 
 
521
def sha_strings(strings):
 
 
522
    """Return the sha-1 of concatenation of strings"""
 
 
524
    map(s.update, strings)
 
 
534
def fingerprint_file(f):
 
 
539
    return {'size': size,
 
 
540
            'sha1': s.hexdigest()}
 
 
543
def compare_files(a, b):
 
 
544
    """Returns true if equal in contents"""
 
 
555
def local_time_offset(t=None):
 
 
556
    """Return offset of local zone from GMT, either at present or at time t."""
 
 
557
    # python2.3 localtime() can't take None
 
 
561
    if time.localtime(t).tm_isdst and time.daylight:
 
 
564
        return -time.timezone
 
 
567
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
 
569
    ## TODO: Perhaps a global option to use either universal or local time?
 
 
570
    ## Or perhaps just let people set $TZ?
 
 
571
    assert isinstance(t, float)
 
 
573
    if timezone == 'utc':
 
 
576
    elif timezone == 'original':
 
 
579
        tt = time.gmtime(t + offset)
 
 
580
    elif timezone == 'local':
 
 
581
        tt = time.localtime(t)
 
 
582
        offset = local_time_offset(t)
 
 
584
        raise BzrError("unsupported timezone format %r" % timezone,
 
 
585
                       ['options are "utc", "original", "local"'])
 
 
587
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
 
589
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
 
592
    return (time.strftime(date_fmt, tt) +  offset_str)
 
 
595
def compact_date(when):
 
 
596
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
 
599
def format_delta(delta):
 
 
600
    """Get a nice looking string for a time delta.
 
 
602
    :param delta: The time difference in seconds, can be positive or negative.
 
 
603
        positive indicates time in the past, negative indicates time in the
 
 
604
        future. (usually time.time() - stored_time)
 
 
605
    :return: String formatted to show approximate resolution
 
 
611
        direction = 'in the future'
 
 
615
    if seconds < 90: # print seconds up to 90 seconds
 
 
617
            return '%d second %s' % (seconds, direction,)
 
 
619
            return '%d seconds %s' % (seconds, direction)
 
 
621
    minutes = int(seconds / 60)
 
 
622
    seconds -= 60 * minutes
 
 
627
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
 
629
            return '%d minute, %d second%s %s' % (
 
 
630
                    minutes, seconds, plural_seconds, direction)
 
 
632
            return '%d minutes, %d second%s %s' % (
 
 
633
                    minutes, seconds, plural_seconds, direction)
 
 
635
    hours = int(minutes / 60)
 
 
636
    minutes -= 60 * hours
 
 
643
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
 
644
                                            plural_minutes, direction)
 
 
645
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
 
646
                                         plural_minutes, direction)
 
 
649
    """Return size of given open file."""
 
 
650
    return os.fstat(f.fileno())[ST_SIZE]
 
 
653
# Define rand_bytes based on platform.
 
 
655
    # Python 2.4 and later have os.urandom,
 
 
656
    # but it doesn't work on some arches
 
 
658
    rand_bytes = os.urandom
 
 
659
except (NotImplementedError, AttributeError):
 
 
660
    # If python doesn't have os.urandom, or it doesn't work,
 
 
661
    # then try to first pull random data from /dev/urandom
 
 
663
        rand_bytes = file('/dev/urandom', 'rb').read
 
 
664
    # Otherwise, use this hack as a last resort
 
 
665
    except (IOError, OSError):
 
 
666
        # not well seeded, but better than nothing
 
 
671
                s += chr(random.randint(0, 255))
 
 
676
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
 
678
    """Return a random string of num alphanumeric characters
 
 
680
    The result only contains lowercase chars because it may be used on 
 
 
681
    case-insensitive filesystems.
 
 
684
    for raw_byte in rand_bytes(num):
 
 
685
        s += ALNUM[ord(raw_byte) % 36]
 
 
689
## TODO: We could later have path objects that remember their list
 
 
690
## decomposition (might be too tricksy though.)
 
 
693
    """Turn string into list of parts.
 
 
699
    >>> splitpath('a/./b')
 
 
701
    >>> splitpath('a/.b')
 
 
703
    >>> splitpath('a/../b')
 
 
704
    Traceback (most recent call last):
 
 
706
    BzrError: sorry, '..' not allowed in path
 
 
708
    assert isinstance(p, types.StringTypes)
 
 
710
    # split on either delimiter because people might use either on
 
 
712
    ps = re.split(r'[\\/]', p)
 
 
717
            raise BzrError("sorry, %r not allowed in path" % f)
 
 
718
        elif (f == '.') or (f == ''):
 
 
725
    assert isinstance(p, list)
 
 
727
        if (f == '..') or (f is None) or (f == ''):
 
 
728
            raise BzrError("sorry, %r not allowed in path" % f)
 
 
732
@deprecated_function(zero_nine)
 
 
733
def appendpath(p1, p2):
 
 
737
        return pathjoin(p1, p2)
 
 
741
    """Split s into lines, but without removing the newline characters."""
 
 
742
    lines = s.split('\n')
 
 
743
    result = [line + '\n' for line in lines[:-1]]
 
 
745
        result.append(lines[-1])
 
 
749
def hardlinks_good():
 
 
750
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
 
753
def link_or_copy(src, dest):
 
 
754
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
 
755
    if not hardlinks_good():
 
 
760
    except (OSError, IOError), e:
 
 
761
        if e.errno != errno.EXDEV:
 
 
765
def delete_any(full_path):
 
 
766
    """Delete a file or directory."""
 
 
770
    # We may be renaming a dangling inventory id
 
 
771
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
 
777
    if getattr(os, 'symlink', None) is not None:
 
 
783
def contains_whitespace(s):
 
 
784
    """True if there are any whitespace characters in s."""
 
 
785
    for ch in string.whitespace:
 
 
792
def contains_linebreaks(s):
 
 
793
    """True if there is any vertical whitespace in s."""
 
 
801
def relpath(base, path):
 
 
802
    """Return path relative to base, or raise exception.
 
 
804
    The path may be either an absolute path or a path relative to the
 
 
805
    current working directory.
 
 
807
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
 
808
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
 
812
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
 
813
        ' exceed the platform minimum length (which is %d)' % 
 
 
820
    while len(head) >= len(base):
 
 
823
        head, tail = os.path.split(head)
 
 
827
        raise PathNotChild(rp, base)
 
 
835
def safe_unicode(unicode_or_utf8_string):
 
 
836
    """Coerce unicode_or_utf8_string into unicode.
 
 
838
    If it is unicode, it is returned.
 
 
839
    Otherwise it is decoded from utf-8. If a decoding error
 
 
840
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
 
841
    as a BzrBadParameter exception.
 
 
843
    if isinstance(unicode_or_utf8_string, unicode):
 
 
844
        return unicode_or_utf8_string
 
 
846
        return unicode_or_utf8_string.decode('utf8')
 
 
847
    except UnicodeDecodeError:
 
 
848
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
 
851
_platform_normalizes_filenames = False
 
 
852
if sys.platform == 'darwin':
 
 
853
    _platform_normalizes_filenames = True
 
 
856
def normalizes_filenames():
 
 
857
    """Return True if this platform normalizes unicode filenames.
 
 
859
    Mac OSX does, Windows/Linux do not.
 
 
861
    return _platform_normalizes_filenames
 
 
864
def _accessible_normalized_filename(path):
 
 
865
    """Get the unicode normalized path, and if you can access the file.
 
 
867
    On platforms where the system normalizes filenames (Mac OSX),
 
 
868
    you can access a file by any path which will normalize correctly.
 
 
869
    On platforms where the system does not normalize filenames 
 
 
870
    (Windows, Linux), you have to access a file by its exact path.
 
 
872
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
 
873
    the standard for XML documents.
 
 
875
    So return the normalized path, and a flag indicating if the file
 
 
876
    can be accessed by that path.
 
 
879
    return unicodedata.normalize('NFKC', unicode(path)), True
 
 
882
def _inaccessible_normalized_filename(path):
 
 
883
    __doc__ = _accessible_normalized_filename.__doc__
 
 
885
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
 
886
    return normalized, normalized == path
 
 
889
if _platform_normalizes_filenames:
 
 
890
    normalized_filename = _accessible_normalized_filename
 
 
892
    normalized_filename = _inaccessible_normalized_filename
 
 
895
def terminal_width():
 
 
896
    """Return estimated terminal width."""
 
 
897
    if sys.platform == 'win32':
 
 
898
        import bzrlib.win32console
 
 
899
        return bzrlib.win32console.get_console_size()[0]
 
 
902
        import struct, fcntl, termios
 
 
903
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
 
904
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
 
905
        width = struct.unpack('HHHH', x)[1]
 
 
910
            width = int(os.environ['COLUMNS'])
 
 
919
def supports_executable():
 
 
920
    return sys.platform != "win32"
 
 
923
def set_or_unset_env(env_variable, value):
 
 
924
    """Modify the environment, setting or removing the env_variable.
 
 
926
    :param env_variable: The environment variable in question
 
 
927
    :param value: The value to set the environment to. If None, then
 
 
928
        the variable will be removed.
 
 
929
    :return: The original value of the environment variable.
 
 
931
    orig_val = os.environ.get(env_variable)
 
 
933
        if orig_val is not None:
 
 
934
            del os.environ[env_variable]
 
 
936
        if isinstance(value, unicode):
 
 
937
            value = value.encode(bzrlib.user_encoding)
 
 
938
        os.environ[env_variable] = value
 
 
942
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
 
945
def check_legal_path(path):
 
 
946
    """Check whether the supplied path is legal.  
 
 
947
    This is only required on Windows, so we don't test on other platforms
 
 
950
    if sys.platform != "win32":
 
 
952
    if _validWin32PathRE.match(path) is None:
 
 
953
        raise IllegalPath(path)
 
 
956
def walkdirs(top, prefix=""):
 
 
957
    """Yield data about all the directories in a tree.
 
 
959
    This yields all the data about the contents of a directory at a time.
 
 
960
    After each directory has been yielded, if the caller has mutated the list
 
 
961
    to exclude some directories, they are then not descended into.
 
 
963
    The data yielded is of the form:
 
 
964
    ((directory-relpath, directory-path-from-top),
 
 
965
    [(relpath, basename, kind, lstat), ...]),
 
 
966
     - directory-relpath is the relative path of the directory being returned
 
 
967
       with respect to top. prefix is prepended to this.
 
 
968
     - directory-path-from-root is the path including top for this directory. 
 
 
969
       It is suitable for use with os functions.
 
 
970
     - relpath is the relative path within the subtree being walked.
 
 
971
     - basename is the basename of the path
 
 
972
     - kind is the kind of the file now. If unknown then the file is not
 
 
973
       present within the tree - but it may be recorded as versioned. See
 
 
975
     - lstat is the stat data *if* the file was statted.
 
 
976
     - planned, not implemented: 
 
 
977
       path_from_tree_root is the path from the root of the tree.
 
 
979
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
 
980
        allows one to walk a subtree but get paths that are relative to a tree
 
 
982
    :return: an iterator over the dirs.
 
 
984
    #TODO there is a bit of a smell where the results of the directory-
 
 
985
    # summary in this, and the path from the root, may not agree 
 
 
986
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
 
987
    # potentially confusing output. We should make this more robust - but
 
 
988
    # not at a speed cost. RBC 20060731
 
 
991
    _directory = _directory_kind
 
 
993
    pending = [(prefix, "", _directory, None, top)]
 
 
996
        currentdir = pending.pop()
 
 
997
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
 
1000
            relroot = currentdir[0] + '/'
 
 
1003
        for name in sorted(_listdir(top)):
 
 
1004
            abspath = top + '/' + name
 
 
1005
            statvalue = lstat(abspath)
 
 
1006
            dirblock.append((relroot + name, name,
 
 
1007
                file_kind_from_stat_mode(statvalue.st_mode),
 
 
1008
                statvalue, abspath))
 
 
1009
        yield (currentdir[0], top), dirblock
 
 
1010
        # push the user specified dirs from dirblock
 
 
1011
        for dir in reversed(dirblock):
 
 
1012
            if dir[2] == _directory:
 
 
1016
def copy_tree(from_path, to_path, handlers={}):
 
 
1017
    """Copy all of the entries in from_path into to_path.
 
 
1019
    :param from_path: The base directory to copy. 
 
 
1020
    :param to_path: The target directory. If it does not exist, it will
 
 
1022
    :param handlers: A dictionary of functions, which takes a source and
 
 
1023
        destinations for files, directories, etc.
 
 
1024
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
 
1025
        'file', 'directory', and 'symlink' should always exist.
 
 
1026
        If they are missing, they will be replaced with 'os.mkdir()',
 
 
1027
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
 
1029
    # Now, just copy the existing cached tree to the new location
 
 
1030
    # We use a cheap trick here.
 
 
1031
    # Absolute paths are prefixed with the first parameter
 
 
1032
    # relative paths are prefixed with the second.
 
 
1033
    # So we can get both the source and target returned
 
 
1034
    # without any extra work.
 
 
1036
    def copy_dir(source, dest):
 
 
1039
    def copy_link(source, dest):
 
 
1040
        """Copy the contents of a symlink"""
 
 
1041
        link_to = os.readlink(source)
 
 
1042
        os.symlink(link_to, dest)
 
 
1044
    real_handlers = {'file':shutil.copy2,
 
 
1045
                     'symlink':copy_link,
 
 
1046
                     'directory':copy_dir,
 
 
1048
    real_handlers.update(handlers)
 
 
1050
    if not os.path.exists(to_path):
 
 
1051
        real_handlers['directory'](from_path, to_path)
 
 
1053
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
 
1054
        for relpath, name, kind, st, abspath in entries:
 
 
1055
            real_handlers[kind](abspath, relpath)
 
 
1058
def path_prefix_key(path):
 
 
1059
    """Generate a prefix-order path key for path.
 
 
1061
    This can be used to sort paths in the same way that walkdirs does.
 
 
1063
    return (dirname(path) , path)
 
 
1066
def compare_paths_prefix_order(path_a, path_b):
 
 
1067
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
 
1068
    key_a = path_prefix_key(path_a)
 
 
1069
    key_b = path_prefix_key(path_b)
 
 
1070
    return cmp(key_a, key_b)
 
 
1073
_cached_user_encoding = None
 
 
1076
def get_user_encoding():
 
 
1077
    """Find out what the preferred user encoding is.
 
 
1079
    This is generally the encoding that is used for command line parameters
 
 
1080
    and file contents. This may be different from the terminal encoding
 
 
1081
    or the filesystem encoding.
 
 
1083
    :return: A string defining the preferred user encoding
 
 
1085
    global _cached_user_encoding
 
 
1086
    if _cached_user_encoding is not None:
 
 
1087
        return _cached_user_encoding
 
 
1089
    if sys.platform == 'darwin':
 
 
1090
        # work around egregious python 2.4 bug
 
 
1091
        sys.platform = 'posix'
 
 
1095
            sys.platform = 'darwin'
 
 
1100
        _cached_user_encoding = locale.getpreferredencoding()
 
 
1101
    except locale.Error, e:
 
 
1102
        sys.stderr.write('bzr: warning: %s\n'
 
 
1103
                         '  Could not determine what text encoding to use.\n'
 
 
1104
                         '  This error usually means your Python interpreter\n'
 
 
1105
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
 
1106
                         "  Continuing with ascii encoding.\n"
 
 
1107
                         % (e, os.environ.get('LANG')))
 
 
1109
    if _cached_user_encoding is None:
 
 
1110
        _cached_user_encoding = 'ascii'
 
 
1111
    return _cached_user_encoding