/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: John Arbash Meinel
  • Date: 2006-11-10 21:06:11 UTC
  • mto: This revision was merged to the branch mainline in revision 2159.
  • Revision ID: john@arbash-meinel.com-20061110210611-ee346404477ecb86
Fix imports to ensure modules are loaded before they are used

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Bazaar -- distributed version control
 
2
#
 
3
# Copyright (C) 2005 Canonical Ltd
 
4
#
 
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.
 
9
#
 
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.
 
14
#
 
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
 
18
 
 
19
from cStringIO import StringIO
 
20
import os
 
21
import re
 
22
import stat
 
23
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
24
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
25
import sys
 
26
import time
 
27
 
 
28
from bzrlib.lazy_import import lazy_import
 
29
lazy_import(globals(), """
 
30
import errno
 
31
from ntpath import (abspath as _nt_abspath,
 
32
                    join as _nt_join,
 
33
                    normpath as _nt_normpath,
 
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
 
36
                    )
 
37
import posixpath
 
38
import sha
 
39
import shutil
 
40
from shutil import (
 
41
    rmtree,
 
42
    )
 
43
import string
 
44
import tempfile
 
45
from tempfile import (
 
46
    mkdtemp,
 
47
    )
 
48
import unicodedata
 
49
 
 
50
from bzrlib import (
 
51
    errors,
 
52
    )
 
53
""")
 
54
 
 
55
import bzrlib
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    zero_nine,
 
59
    )
 
60
from bzrlib.trace import mutter
 
61
 
 
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
 
 
71
def make_readonly(filename):
 
72
    """Make a filename read-only."""
 
73
    mod = os.stat(filename).st_mode
 
74
    mod = mod & 0777555
 
75
    os.chmod(filename, mod)
 
76
 
 
77
 
 
78
def make_writable(filename):
 
79
    mod = os.stat(filename).st_mode
 
80
    mod = mod | 0200
 
81
    os.chmod(filename, mod)
 
82
 
 
83
 
 
84
_QUOTE_RE = None
 
85
 
 
86
 
 
87
def quotefn(f):
 
88
    """Return a quoted filename filename
 
89
 
 
90
    This previously used backslash quoting, but that works poorly on
 
91
    Windows."""
 
92
    # TODO: I'm not really sure this is the best format either.x
 
93
    global _QUOTE_RE
 
94
    if _QUOTE_RE is None:
 
95
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
96
        
 
97
    if _QUOTE_RE.search(f):
 
98
        return '"' + f + '"'
 
99
    else:
 
100
        return f
 
101
 
 
102
 
 
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
 
144
 
 
145
 
 
146
def kind_marker(kind):
 
147
    if kind == 'file':
 
148
        return ''
 
149
    elif kind == _directory_kind:
 
150
        return '/'
 
151
    elif kind == 'symlink':
 
152
        return '@'
 
153
    else:
 
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
 
 
171
 
 
172
def fancy_rename(old, new, rename_func, unlink_func):
 
173
    """A fancy rename, when you don't have atomic rename.
 
174
    
 
175
    :param old: The old path, to rename from
 
176
    :param new: The new path, to rename to
 
177
    :param rename_func: The potentially non-atomic rename function
 
178
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
179
    """
 
180
 
 
181
    # sftp rename doesn't allow overwriting, so play tricks:
 
182
    import random
 
183
    base = os.path.basename(new)
 
184
    dirname = os.path.dirname(new)
 
185
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
186
    tmp_name = pathjoin(dirname, tmp_name)
 
187
 
 
188
    # Rename the file out of the way, but keep track if it didn't exist
 
189
    # We don't want to grab just any exception
 
190
    # something like EACCES should prevent us from continuing
 
191
    # The downside is that the rename_func has to throw an exception
 
192
    # with an errno = ENOENT, or NoSuchFile
 
193
    file_existed = False
 
194
    try:
 
195
        rename_func(new, tmp_name)
 
196
    except (errors.NoSuchFile,), e:
 
197
        pass
 
198
    except IOError, e:
 
199
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
200
        # function raises an IOError with errno is None when a rename fails.
 
201
        # This then gets caught here.
 
202
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
203
            raise
 
204
    except Exception, e:
 
205
        if (getattr(e, 'errno', None) is None
 
206
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
207
            raise
 
208
    else:
 
209
        file_existed = True
 
210
 
 
211
    success = False
 
212
    try:
 
213
        # This may throw an exception, in which case success will
 
214
        # not be set.
 
215
        rename_func(old, new)
 
216
        success = True
 
217
    finally:
 
218
        if file_existed:
 
219
            # If the file used to exist, rename it back into place
 
220
            # otherwise just delete it from the tmp location
 
221
            if success:
 
222
                unlink_func(tmp_name)
 
223
            else:
 
224
                rename_func(tmp_name, new)
 
225
 
 
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
 
309
pathjoin = os.path.join
 
310
normpath = os.path.normpath
 
311
getcwd = os.getcwdu
 
312
rename = os.rename
 
313
dirname = os.path.dirname
 
314
basename = os.path.basename
 
315
# These were already imported into local scope
 
316
# mkdtemp = tempfile.mkdtemp
 
317
# rmtree = shutil.rmtree
 
318
 
 
319
MIN_ABS_PATHLENGTH = 1
 
320
 
 
321
 
 
322
if sys.platform == 'win32':
 
323
    abspath = _win32_abspath
 
324
    realpath = _win32_realpath
 
325
    pathjoin = _win32_pathjoin
 
326
    normpath = _win32_normpath
 
327
    getcwd = _win32_getcwd
 
328
    mkdtemp = _win32_mkdtemp
 
329
    rename = _win32_rename
 
330
 
 
331
    MIN_ABS_PATHLENGTH = 3
 
332
 
 
333
    def _win32_delete_readonly(function, path, excinfo):
 
334
        """Error handler for shutil.rmtree function [for win32]
 
335
        Helps to remove files and dirs marked as read-only.
 
336
        """
 
337
        type_, value = excinfo[:2]
 
338
        if function in (os.remove, os.rmdir) \
 
339
            and type_ == OSError \
 
340
            and value.errno == errno.EACCES:
 
341
            make_writable(path)
 
342
            function(path)
 
343
        else:
 
344
            raise
 
345
 
 
346
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
347
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
348
        return shutil.rmtree(path, ignore_errors, onerror)
 
349
elif sys.platform == 'darwin':
 
350
    getcwd = _mac_getcwd
 
351
 
 
352
 
 
353
def get_terminal_encoding():
 
354
    """Find the best encoding for printing to the screen.
 
355
 
 
356
    This attempts to check both sys.stdout and sys.stdin to see
 
357
    what encoding they are in, and if that fails it falls back to
 
358
    bzrlib.user_encoding.
 
359
    The problem is that on Windows, locale.getpreferredencoding()
 
360
    is not the same encoding as that used by the console:
 
361
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
362
 
 
363
    On my standard US Windows XP, the preferred encoding is
 
364
    cp1252, but the console is cp437
 
365
    """
 
366
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
367
    if not output_encoding:
 
368
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
369
        if not input_encoding:
 
370
            output_encoding = bzrlib.user_encoding
 
371
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
372
        else:
 
373
            output_encoding = input_encoding
 
374
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
375
    else:
 
376
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
377
    return output_encoding
 
378
 
 
379
 
 
380
def normalizepath(f):
 
381
    if getattr(os.path, 'realpath', None) is not None:
 
382
        F = realpath
 
383
    else:
 
384
        F = abspath
 
385
    [p,e] = os.path.split(f)
 
386
    if e == "" or e == "." or e == "..":
 
387
        return F(f)
 
388
    else:
 
389
        return pathjoin(F(p), e)
 
390
 
 
391
 
 
392
def backup_file(fn):
 
393
    """Copy a file to a backup.
 
394
 
 
395
    Backups are named in GNU-style, with a ~ suffix.
 
396
 
 
397
    If the file is already a backup, it's not copied.
 
398
    """
 
399
    if fn[-1] == '~':
 
400
        return
 
401
    bfn = fn + '~'
 
402
 
 
403
    if has_symlinks() and os.path.islink(fn):
 
404
        target = os.readlink(fn)
 
405
        os.symlink(target, bfn)
 
406
        return
 
407
    inf = file(fn, 'rb')
 
408
    try:
 
409
        content = inf.read()
 
410
    finally:
 
411
        inf.close()
 
412
    
 
413
    outf = file(bfn, 'wb')
 
414
    try:
 
415
        outf.write(content)
 
416
    finally:
 
417
        outf.close()
 
418
 
 
419
 
 
420
def isdir(f):
 
421
    """True if f is an accessible directory."""
 
422
    try:
 
423
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
424
    except OSError:
 
425
        return False
 
426
 
 
427
 
 
428
def isfile(f):
 
429
    """True if f is a regular file."""
 
430
    try:
 
431
        return S_ISREG(os.lstat(f)[ST_MODE])
 
432
    except OSError:
 
433
        return False
 
434
 
 
435
def islink(f):
 
436
    """True if f is a symlink."""
 
437
    try:
 
438
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
439
    except OSError:
 
440
        return False
 
441
 
 
442
def is_inside(dir, fname):
 
443
    """True if fname is inside dir.
 
444
    
 
445
    The parameters should typically be passed to osutils.normpath first, so
 
446
    that . and .. and repeated slashes are eliminated, and the separators
 
447
    are canonical for the platform.
 
448
    
 
449
    The empty string as a dir name is taken as top-of-tree and matches 
 
450
    everything.
 
451
    """
 
452
    # XXX: Most callers of this can actually do something smarter by 
 
453
    # looking at the inventory
 
454
    if dir == fname:
 
455
        return True
 
456
    
 
457
    if dir == '':
 
458
        return True
 
459
 
 
460
    if dir[-1] != '/':
 
461
        dir += '/'
 
462
 
 
463
    return fname.startswith(dir)
 
464
 
 
465
 
 
466
def is_inside_any(dir_list, fname):
 
467
    """True if fname is inside any of given dirs."""
 
468
    for dirname in dir_list:
 
469
        if is_inside(dirname, fname):
 
470
            return True
 
471
    else:
 
472
        return False
 
473
 
 
474
 
 
475
def is_inside_or_parent_of_any(dir_list, fname):
 
476
    """True if fname is a child or a parent of any of the given files."""
 
477
    for dirname in dir_list:
 
478
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
479
            return True
 
480
    else:
 
481
        return False
 
482
 
 
483
 
 
484
def pumpfile(fromfile, tofile):
 
485
    """Copy contents of one file to another."""
 
486
    BUFSIZE = 32768
 
487
    while True:
 
488
        b = fromfile.read(BUFSIZE)
 
489
        if not b:
 
490
            break
 
491
        tofile.write(b)
 
492
 
 
493
 
 
494
def file_iterator(input_file, readsize=32768):
 
495
    while True:
 
496
        b = input_file.read(readsize)
 
497
        if len(b) == 0:
 
498
            break
 
499
        yield b
 
500
 
 
501
 
 
502
def sha_file(f):
 
503
    if getattr(f, 'tell', None) is not None:
 
504
        assert f.tell() == 0
 
505
    s = sha.new()
 
506
    BUFSIZE = 128<<10
 
507
    while True:
 
508
        b = f.read(BUFSIZE)
 
509
        if not b:
 
510
            break
 
511
        s.update(b)
 
512
    return s.hexdigest()
 
513
 
 
514
 
 
515
 
 
516
def sha_strings(strings):
 
517
    """Return the sha-1 of concatenation of strings"""
 
518
    s = sha.new()
 
519
    map(s.update, strings)
 
520
    return s.hexdigest()
 
521
 
 
522
 
 
523
def sha_string(f):
 
524
    s = sha.new()
 
525
    s.update(f)
 
526
    return s.hexdigest()
 
527
 
 
528
 
 
529
def fingerprint_file(f):
 
530
    s = sha.new()
 
531
    b = f.read()
 
532
    s.update(b)
 
533
    size = len(b)
 
534
    return {'size': size,
 
535
            'sha1': s.hexdigest()}
 
536
 
 
537
 
 
538
def compare_files(a, b):
 
539
    """Returns true if equal in contents"""
 
540
    BUFSIZE = 4096
 
541
    while True:
 
542
        ai = a.read(BUFSIZE)
 
543
        bi = b.read(BUFSIZE)
 
544
        if ai != bi:
 
545
            return False
 
546
        if ai == '':
 
547
            return True
 
548
 
 
549
 
 
550
def local_time_offset(t=None):
 
551
    """Return offset of local zone from GMT, either at present or at time t."""
 
552
    # python2.3 localtime() can't take None
 
553
    if t is None:
 
554
        t = time.time()
 
555
        
 
556
    if time.localtime(t).tm_isdst and time.daylight:
 
557
        return -time.altzone
 
558
    else:
 
559
        return -time.timezone
 
560
 
 
561
    
 
562
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
563
                show_offset=True):
 
564
    ## TODO: Perhaps a global option to use either universal or local time?
 
565
    ## Or perhaps just let people set $TZ?
 
566
    assert isinstance(t, float)
 
567
    
 
568
    if timezone == 'utc':
 
569
        tt = time.gmtime(t)
 
570
        offset = 0
 
571
    elif timezone == 'original':
 
572
        if offset is None:
 
573
            offset = 0
 
574
        tt = time.gmtime(t + offset)
 
575
    elif timezone == 'local':
 
576
        tt = time.localtime(t)
 
577
        offset = local_time_offset(t)
 
578
    else:
 
579
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
580
                              ['options are "utc", "original", "local"'])
 
581
    if date_fmt is None:
 
582
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
583
    if show_offset:
 
584
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
585
    else:
 
586
        offset_str = ''
 
587
    return (time.strftime(date_fmt, tt) +  offset_str)
 
588
 
 
589
 
 
590
def compact_date(when):
 
591
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
592
    
 
593
 
 
594
def format_delta(delta):
 
595
    """Get a nice looking string for a time delta.
 
596
 
 
597
    :param delta: The time difference in seconds, can be positive or negative.
 
598
        positive indicates time in the past, negative indicates time in the
 
599
        future. (usually time.time() - stored_time)
 
600
    :return: String formatted to show approximate resolution
 
601
    """
 
602
    delta = int(delta)
 
603
    if delta >= 0:
 
604
        direction = 'ago'
 
605
    else:
 
606
        direction = 'in the future'
 
607
        delta = -delta
 
608
 
 
609
    seconds = delta
 
610
    if seconds < 90: # print seconds up to 90 seconds
 
611
        if seconds == 1:
 
612
            return '%d second %s' % (seconds, direction,)
 
613
        else:
 
614
            return '%d seconds %s' % (seconds, direction)
 
615
 
 
616
    minutes = int(seconds / 60)
 
617
    seconds -= 60 * minutes
 
618
    if seconds == 1:
 
619
        plural_seconds = ''
 
620
    else:
 
621
        plural_seconds = 's'
 
622
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
623
        if minutes == 1:
 
624
            return '%d minute, %d second%s %s' % (
 
625
                    minutes, seconds, plural_seconds, direction)
 
626
        else:
 
627
            return '%d minutes, %d second%s %s' % (
 
628
                    minutes, seconds, plural_seconds, direction)
 
629
 
 
630
    hours = int(minutes / 60)
 
631
    minutes -= 60 * hours
 
632
    if minutes == 1:
 
633
        plural_minutes = ''
 
634
    else:
 
635
        plural_minutes = 's'
 
636
 
 
637
    if hours == 1:
 
638
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
639
                                            plural_minutes, direction)
 
640
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
641
                                         plural_minutes, direction)
 
642
 
 
643
def filesize(f):
 
644
    """Return size of given open file."""
 
645
    return os.fstat(f.fileno())[ST_SIZE]
 
646
 
 
647
 
 
648
# Define rand_bytes based on platform.
 
649
try:
 
650
    # Python 2.4 and later have os.urandom,
 
651
    # but it doesn't work on some arches
 
652
    os.urandom(1)
 
653
    rand_bytes = os.urandom
 
654
except (NotImplementedError, AttributeError):
 
655
    # If python doesn't have os.urandom, or it doesn't work,
 
656
    # then try to first pull random data from /dev/urandom
 
657
    try:
 
658
        rand_bytes = file('/dev/urandom', 'rb').read
 
659
    # Otherwise, use this hack as a last resort
 
660
    except (IOError, OSError):
 
661
        # not well seeded, but better than nothing
 
662
        def rand_bytes(n):
 
663
            import random
 
664
            s = ''
 
665
            while n:
 
666
                s += chr(random.randint(0, 255))
 
667
                n -= 1
 
668
            return s
 
669
 
 
670
 
 
671
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
672
def rand_chars(num):
 
673
    """Return a random string of num alphanumeric characters
 
674
    
 
675
    The result only contains lowercase chars because it may be used on 
 
676
    case-insensitive filesystems.
 
677
    """
 
678
    s = ''
 
679
    for raw_byte in rand_bytes(num):
 
680
        s += ALNUM[ord(raw_byte) % 36]
 
681
    return s
 
682
 
 
683
 
 
684
## TODO: We could later have path objects that remember their list
 
685
## decomposition (might be too tricksy though.)
 
686
 
 
687
def splitpath(p):
 
688
    """Turn string into list of parts."""
 
689
    assert isinstance(p, basestring)
 
690
 
 
691
    # split on either delimiter because people might use either on
 
692
    # Windows
 
693
    ps = re.split(r'[\\/]', p)
 
694
 
 
695
    rps = []
 
696
    for f in ps:
 
697
        if f == '..':
 
698
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
699
        elif (f == '.') or (f == ''):
 
700
            pass
 
701
        else:
 
702
            rps.append(f)
 
703
    return rps
 
704
 
 
705
def joinpath(p):
 
706
    assert isinstance(p, list)
 
707
    for f in p:
 
708
        if (f == '..') or (f is None) or (f == ''):
 
709
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
710
    return pathjoin(*p)
 
711
 
 
712
 
 
713
@deprecated_function(zero_nine)
 
714
def appendpath(p1, p2):
 
715
    if p1 == '':
 
716
        return p2
 
717
    else:
 
718
        return pathjoin(p1, p2)
 
719
    
 
720
 
 
721
def split_lines(s):
 
722
    """Split s into lines, but without removing the newline characters."""
 
723
    lines = s.split('\n')
 
724
    result = [line + '\n' for line in lines[:-1]]
 
725
    if lines[-1]:
 
726
        result.append(lines[-1])
 
727
    return result
 
728
 
 
729
 
 
730
def hardlinks_good():
 
731
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
732
 
 
733
 
 
734
def link_or_copy(src, dest):
 
735
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
736
    if not hardlinks_good():
 
737
        shutil.copyfile(src, dest)
 
738
        return
 
739
    try:
 
740
        os.link(src, dest)
 
741
    except (OSError, IOError), e:
 
742
        if e.errno != errno.EXDEV:
 
743
            raise
 
744
        shutil.copyfile(src, dest)
 
745
 
 
746
def delete_any(full_path):
 
747
    """Delete a file or directory."""
 
748
    try:
 
749
        os.unlink(full_path)
 
750
    except OSError, e:
 
751
    # We may be renaming a dangling inventory id
 
752
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
753
            raise
 
754
        os.rmdir(full_path)
 
755
 
 
756
 
 
757
def has_symlinks():
 
758
    if getattr(os, 'symlink', None) is not None:
 
759
        return True
 
760
    else:
 
761
        return False
 
762
        
 
763
 
 
764
def contains_whitespace(s):
 
765
    """True if there are any whitespace characters in s."""
 
766
    for ch in string.whitespace:
 
767
        if ch in s:
 
768
            return True
 
769
    else:
 
770
        return False
 
771
 
 
772
 
 
773
def contains_linebreaks(s):
 
774
    """True if there is any vertical whitespace in s."""
 
775
    for ch in '\f\n\r':
 
776
        if ch in s:
 
777
            return True
 
778
    else:
 
779
        return False
 
780
 
 
781
 
 
782
def relpath(base, path):
 
783
    """Return path relative to base, or raise exception.
 
784
 
 
785
    The path may be either an absolute path or a path relative to the
 
786
    current working directory.
 
787
 
 
788
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
789
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
790
    avoids that problem.
 
791
    """
 
792
 
 
793
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
794
        ' exceed the platform minimum length (which is %d)' % 
 
795
        MIN_ABS_PATHLENGTH)
 
796
 
 
797
    rp = abspath(path)
 
798
 
 
799
    s = []
 
800
    head = rp
 
801
    while len(head) >= len(base):
 
802
        if head == base:
 
803
            break
 
804
        head, tail = os.path.split(head)
 
805
        if tail:
 
806
            s.insert(0, tail)
 
807
    else:
 
808
        raise errors.PathNotChild(rp, base)
 
809
 
 
810
    if s:
 
811
        return pathjoin(*s)
 
812
    else:
 
813
        return ''
 
814
 
 
815
 
 
816
def safe_unicode(unicode_or_utf8_string):
 
817
    """Coerce unicode_or_utf8_string into unicode.
 
818
 
 
819
    If it is unicode, it is returned.
 
820
    Otherwise it is decoded from utf-8. If a decoding error
 
821
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
822
    as a BzrBadParameter exception.
 
823
    """
 
824
    if isinstance(unicode_or_utf8_string, unicode):
 
825
        return unicode_or_utf8_string
 
826
    try:
 
827
        return unicode_or_utf8_string.decode('utf8')
 
828
    except UnicodeDecodeError:
 
829
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
830
 
 
831
 
 
832
_platform_normalizes_filenames = False
 
833
if sys.platform == 'darwin':
 
834
    _platform_normalizes_filenames = True
 
835
 
 
836
 
 
837
def normalizes_filenames():
 
838
    """Return True if this platform normalizes unicode filenames.
 
839
 
 
840
    Mac OSX does, Windows/Linux do not.
 
841
    """
 
842
    return _platform_normalizes_filenames
 
843
 
 
844
 
 
845
def _accessible_normalized_filename(path):
 
846
    """Get the unicode normalized path, and if you can access the file.
 
847
 
 
848
    On platforms where the system normalizes filenames (Mac OSX),
 
849
    you can access a file by any path which will normalize correctly.
 
850
    On platforms where the system does not normalize filenames 
 
851
    (Windows, Linux), you have to access a file by its exact path.
 
852
 
 
853
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
854
    the standard for XML documents.
 
855
 
 
856
    So return the normalized path, and a flag indicating if the file
 
857
    can be accessed by that path.
 
858
    """
 
859
 
 
860
    return unicodedata.normalize('NFKC', unicode(path)), True
 
861
 
 
862
 
 
863
def _inaccessible_normalized_filename(path):
 
864
    __doc__ = _accessible_normalized_filename.__doc__
 
865
 
 
866
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
867
    return normalized, normalized == path
 
868
 
 
869
 
 
870
if _platform_normalizes_filenames:
 
871
    normalized_filename = _accessible_normalized_filename
 
872
else:
 
873
    normalized_filename = _inaccessible_normalized_filename
 
874
 
 
875
 
 
876
def terminal_width():
 
877
    """Return estimated terminal width."""
 
878
    if sys.platform == 'win32':
 
879
        import bzrlib.win32console
 
880
        return bzrlib.win32console.get_console_size()[0]
 
881
    width = 0
 
882
    try:
 
883
        import struct, fcntl, termios
 
884
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
885
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
886
        width = struct.unpack('HHHH', x)[1]
 
887
    except IOError:
 
888
        pass
 
889
    if width <= 0:
 
890
        try:
 
891
            width = int(os.environ['COLUMNS'])
 
892
        except:
 
893
            pass
 
894
    if width <= 0:
 
895
        width = 80
 
896
 
 
897
    return width
 
898
 
 
899
 
 
900
def supports_executable():
 
901
    return sys.platform != "win32"
 
902
 
 
903
 
 
904
def set_or_unset_env(env_variable, value):
 
905
    """Modify the environment, setting or removing the env_variable.
 
906
 
 
907
    :param env_variable: The environment variable in question
 
908
    :param value: The value to set the environment to. If None, then
 
909
        the variable will be removed.
 
910
    :return: The original value of the environment variable.
 
911
    """
 
912
    orig_val = os.environ.get(env_variable)
 
913
    if value is None:
 
914
        if orig_val is not None:
 
915
            del os.environ[env_variable]
 
916
    else:
 
917
        if isinstance(value, unicode):
 
918
            value = value.encode(bzrlib.user_encoding)
 
919
        os.environ[env_variable] = value
 
920
    return orig_val
 
921
 
 
922
 
 
923
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
924
 
 
925
 
 
926
def check_legal_path(path):
 
927
    """Check whether the supplied path is legal.  
 
928
    This is only required on Windows, so we don't test on other platforms
 
929
    right now.
 
930
    """
 
931
    if sys.platform != "win32":
 
932
        return
 
933
    if _validWin32PathRE.match(path) is None:
 
934
        raise errors.IllegalPath(path)
 
935
 
 
936
 
 
937
def walkdirs(top, prefix=""):
 
938
    """Yield data about all the directories in a tree.
 
939
    
 
940
    This yields all the data about the contents of a directory at a time.
 
941
    After each directory has been yielded, if the caller has mutated the list
 
942
    to exclude some directories, they are then not descended into.
 
943
    
 
944
    The data yielded is of the form:
 
945
    ((directory-relpath, directory-path-from-top),
 
946
    [(relpath, basename, kind, lstat), ...]),
 
947
     - directory-relpath is the relative path of the directory being returned
 
948
       with respect to top. prefix is prepended to this.
 
949
     - directory-path-from-root is the path including top for this directory. 
 
950
       It is suitable for use with os functions.
 
951
     - relpath is the relative path within the subtree being walked.
 
952
     - basename is the basename of the path
 
953
     - kind is the kind of the file now. If unknown then the file is not
 
954
       present within the tree - but it may be recorded as versioned. See
 
955
       versioned_kind.
 
956
     - lstat is the stat data *if* the file was statted.
 
957
     - planned, not implemented: 
 
958
       path_from_tree_root is the path from the root of the tree.
 
959
 
 
960
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
961
        allows one to walk a subtree but get paths that are relative to a tree
 
962
        rooted higher up.
 
963
    :return: an iterator over the dirs.
 
964
    """
 
965
    #TODO there is a bit of a smell where the results of the directory-
 
966
    # summary in this, and the path from the root, may not agree 
 
967
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
968
    # potentially confusing output. We should make this more robust - but
 
969
    # not at a speed cost. RBC 20060731
 
970
    lstat = os.lstat
 
971
    pending = []
 
972
    _directory = _directory_kind
 
973
    _listdir = os.listdir
 
974
    pending = [(prefix, "", _directory, None, top)]
 
975
    while pending:
 
976
        dirblock = []
 
977
        currentdir = pending.pop()
 
978
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
979
        top = currentdir[4]
 
980
        if currentdir[0]:
 
981
            relroot = currentdir[0] + '/'
 
982
        else:
 
983
            relroot = ""
 
984
        for name in sorted(_listdir(top)):
 
985
            abspath = top + '/' + name
 
986
            statvalue = lstat(abspath)
 
987
            dirblock.append((relroot + name, name,
 
988
                file_kind_from_stat_mode(statvalue.st_mode),
 
989
                statvalue, abspath))
 
990
        yield (currentdir[0], top), dirblock
 
991
        # push the user specified dirs from dirblock
 
992
        for dir in reversed(dirblock):
 
993
            if dir[2] == _directory:
 
994
                pending.append(dir)
 
995
 
 
996
 
 
997
def copy_tree(from_path, to_path, handlers={}):
 
998
    """Copy all of the entries in from_path into to_path.
 
999
 
 
1000
    :param from_path: The base directory to copy. 
 
1001
    :param to_path: The target directory. If it does not exist, it will
 
1002
        be created.
 
1003
    :param handlers: A dictionary of functions, which takes a source and
 
1004
        destinations for files, directories, etc.
 
1005
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1006
        'file', 'directory', and 'symlink' should always exist.
 
1007
        If they are missing, they will be replaced with 'os.mkdir()',
 
1008
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1009
    """
 
1010
    # Now, just copy the existing cached tree to the new location
 
1011
    # We use a cheap trick here.
 
1012
    # Absolute paths are prefixed with the first parameter
 
1013
    # relative paths are prefixed with the second.
 
1014
    # So we can get both the source and target returned
 
1015
    # without any extra work.
 
1016
 
 
1017
    def copy_dir(source, dest):
 
1018
        os.mkdir(dest)
 
1019
 
 
1020
    def copy_link(source, dest):
 
1021
        """Copy the contents of a symlink"""
 
1022
        link_to = os.readlink(source)
 
1023
        os.symlink(link_to, dest)
 
1024
 
 
1025
    real_handlers = {'file':shutil.copy2,
 
1026
                     'symlink':copy_link,
 
1027
                     'directory':copy_dir,
 
1028
                    }
 
1029
    real_handlers.update(handlers)
 
1030
 
 
1031
    if not os.path.exists(to_path):
 
1032
        real_handlers['directory'](from_path, to_path)
 
1033
 
 
1034
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1035
        for relpath, name, kind, st, abspath in entries:
 
1036
            real_handlers[kind](abspath, relpath)
 
1037
 
 
1038
 
 
1039
def path_prefix_key(path):
 
1040
    """Generate a prefix-order path key for path.
 
1041
 
 
1042
    This can be used to sort paths in the same way that walkdirs does.
 
1043
    """
 
1044
    return (dirname(path) , path)
 
1045
 
 
1046
 
 
1047
def compare_paths_prefix_order(path_a, path_b):
 
1048
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1049
    key_a = path_prefix_key(path_a)
 
1050
    key_b = path_prefix_key(path_b)
 
1051
    return cmp(key_a, key_b)
 
1052
 
 
1053
 
 
1054
_cached_user_encoding = None
 
1055
 
 
1056
 
 
1057
def get_user_encoding():
 
1058
    """Find out what the preferred user encoding is.
 
1059
 
 
1060
    This is generally the encoding that is used for command line parameters
 
1061
    and file contents. This may be different from the terminal encoding
 
1062
    or the filesystem encoding.
 
1063
 
 
1064
    :return: A string defining the preferred user encoding
 
1065
    """
 
1066
    global _cached_user_encoding
 
1067
    if _cached_user_encoding is not None:
 
1068
        return _cached_user_encoding
 
1069
 
 
1070
    if sys.platform == 'darwin':
 
1071
        # work around egregious python 2.4 bug
 
1072
        sys.platform = 'posix'
 
1073
        try:
 
1074
            import locale
 
1075
        finally:
 
1076
            sys.platform = 'darwin'
 
1077
    else:
 
1078
        import locale
 
1079
 
 
1080
    try:
 
1081
        _cached_user_encoding = locale.getpreferredencoding()
 
1082
    except locale.Error, e:
 
1083
        sys.stderr.write('bzr: warning: %s\n'
 
1084
                         '  Could not determine what text encoding to use.\n'
 
1085
                         '  This error usually means your Python interpreter\n'
 
1086
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1087
                         "  Continuing with ascii encoding.\n"
 
1088
                         % (e, os.environ.get('LANG')))
 
1089
 
 
1090
    if _cached_user_encoding is None:
 
1091
        _cached_user_encoding = 'ascii'
 
1092
    return _cached_user_encoding
 
1093
 
 
1094
 
 
1095
def recv_all(socket, bytes):
 
1096
    """Receive an exact number of bytes.
 
1097
 
 
1098
    Regular Socket.recv() may return less than the requested number of bytes,
 
1099
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1100
    on all platforms, but this should work everywhere.  This will return
 
1101
    less than the requested amount if the remote end closes.
 
1102
 
 
1103
    This isn't optimized and is intended mostly for use in testing.
 
1104
    """
 
1105
    b = ''
 
1106
    while len(b) < bytes:
 
1107
        new = socket.recv(bytes - len(b))
 
1108
        if new == '':
 
1109
            break # eof
 
1110
        b += new
 
1111
    return b
 
1112