← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-06-29 02:55:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050629025533-c8fb62423361c8a2
Patch from John:

- StringIO mixes poorly with difflib

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
 
import os, types, re, time, errno
 
19
import os, types, re, time, errno, sys
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
 
22
from bzrlib.errors import BzrError
 
23
from bzrlib.trace import mutter
24
24
import bzrlib
25
25
 
26
26
def make_readonly(filename):
39
39
 
40
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
41
41
def quotefn(f):
42
 
    """Return shell-quoted filename"""
43
 
    ## We could be a bit more terse by using double-quotes etc
44
 
    f = _QUOTE_RE.sub(r'\\\1', f)
45
 
    if f[0] == '~':
46
 
        f[0:1] = r'\~' 
47
 
    return f
 
42
    """Return a quoted filename filename
 
43
 
 
44
    This previously used backslash quoting, but that works poorly on
 
45
    Windows."""
 
46
    # TODO: I'm not really sure this is the best format either.x
 
47
    if _QUOTE_RE.search(f):
 
48
        return '"' + f + '"'
 
49
    else:
 
50
        return f
48
51
 
49
52
 
50
53
def file_kind(f):
56
59
    elif S_ISLNK(mode):
57
60
        return 'symlink'
58
61
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
 
62
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
63
 
 
64
 
 
65
def kind_marker(kind):
 
66
    if kind == 'file':
 
67
        return ''
 
68
    elif kind == 'directory':
 
69
        return '/'
 
70
    elif kind == 'symlink':
 
71
        return '@'
 
72
    else:
 
73
        raise BzrError('invalid file kind %r' % kind)
 
74
 
 
75
 
 
76
 
 
77
def backup_file(fn):
 
78
    """Copy a file to a backup.
 
79
 
 
80
    Backups are named in GNU-style, with a ~ suffix.
 
81
 
 
82
    If the file is already a backup, it's not copied.
 
83
    """
 
84
    import os
 
85
    if fn[-1] == '~':
 
86
        return
 
87
    bfn = fn + '~'
 
88
 
 
89
    inf = file(fn, 'rb')
 
90
    try:
 
91
        content = inf.read()
 
92
    finally:
 
93
        inf.close()
 
94
    
 
95
    outf = file(bfn, 'wb')
 
96
    try:
 
97
        outf.write(content)
 
98
    finally:
 
99
        outf.close()
 
100
 
60
101
 
61
102
 
62
103
 
77
118
        return False
78
119
 
79
120
 
 
121
def is_inside(dir, fname):
 
122
    """True if fname is inside dir.
 
123
    """
 
124
    return os.path.commonprefix([dir, fname]) == dir
 
125
 
 
126
 
 
127
def is_inside_any(dir_list, fname):
 
128
    """True if fname is inside any of given dirs."""
 
129
    # quick scan for perfect match
 
130
    if fname in dir_list:
 
131
        return True
 
132
    
 
133
    for dirname in dir_list:
 
134
        if is_inside(dirname, fname):
 
135
            return True
 
136
    else:
 
137
        return False
 
138
 
 
139
 
80
140
def pumpfile(fromfile, tofile):
81
141
    """Copy contents of one file to another."""
82
142
    tofile.write(fromfile.read())
218
278
    if e:
219
279
        m = _EMAIL_RE.search(e)
220
280
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
281
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
222
282
        return m.group(0)
223
283
 
224
284
    return _auto_user_id()[1]
266
326
        tt = time.localtime(t)
267
327
        offset = local_time_offset(t)
268
328
    else:
269
 
        bailout("unsupported timezone format %r",
 
329
        raise BzrError("unsupported timezone format %r",
270
330
                ['options are "utc", "original", "local"'])
271
331
 
272
332
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
285
345
 
286
346
if hasattr(os, 'urandom'): # python 2.4 and later
287
347
    rand_bytes = os.urandom
 
348
elif sys.platform == 'linux2':
 
349
    rand_bytes = file('/dev/urandom', 'rb').read
288
350
else:
289
 
    # FIXME: No good on non-Linux
290
 
    _rand_file = file('/dev/urandom', 'rb')
291
 
    rand_bytes = _rand_file.read
 
351
    # not well seeded, but better than nothing
 
352
    def rand_bytes(n):
 
353
        import random
 
354
        s = ''
 
355
        while n:
 
356
            s += chr(random.randint(0, 255))
 
357
            n -= 1
 
358
        return s
292
359
 
293
360
 
294
361
## TODO: We could later have path objects that remember their list
308
375
    >>> splitpath('a/../b')
309
376
    Traceback (most recent call last):
310
377
    ...
311
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
378
    BzrError: sorry, '..' not allowed in path
312
379
    """
313
380
    assert isinstance(p, types.StringTypes)
314
381
 
319
386
    rps = []
320
387
    for f in ps:
321
388
        if f == '..':
322
 
            bailout("sorry, %r not allowed in path" % f)
 
389
            raise BzrError("sorry, %r not allowed in path" % f)
323
390
        elif (f == '.') or (f == ''):
324
391
            pass
325
392
        else:
330
397
    assert isinstance(p, list)
331
398
    for f in p:
332
399
        if (f == '..') or (f == None) or (f == ''):
333
 
            bailout("sorry, %r not allowed in path" % f)
 
400
            raise BzrError("sorry, %r not allowed in path" % f)
334
401
    return os.path.join(*p)
335
402
 
336
403
 
345
412
    mutter('external command: %s' % `cmd`)
346
413
    if os.system(cmd):
347
414
        if not ignore_errors:
348
 
            bailout('command failed')
349
 
 
 
415
            raise BzrError('command failed')
 
416
 
 
417
 
 
418
def _read_config_value(name):
 
419
    """Read a config value from the file ~/.bzr.conf/<name>
 
420
    Return None if the file does not exist"""
 
421
    try:
 
422
        f = file(os.path.join(config_dir(), name), "r")
 
423
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
 
424
    except IOError, e:
 
425
        if e.errno == errno.ENOENT:
 
426
            return None
 
427
        raise
 
428
 
 
429
 
 
430
def _get_editor():
 
431
    """Return a sequence of possible editor binaries for the current platform"""
 
432
    e = _read_config_value("editor")
 
433
    if e is not None:
 
434
        yield e
 
435
        
 
436
    if os.name == "windows":
 
437
        yield "notepad.exe"
 
438
    elif os.name == "posix":
 
439
        try:
 
440
            yield os.environ["EDITOR"]
 
441
        except KeyError:
 
442
            yield "/usr/bin/vi"
 
443
 
 
444
 
 
445
def _run_editor(filename):
 
446
    """Try to execute an editor to edit the commit message. Returns True on success,
 
447
    False on failure"""
 
448
    for e in _get_editor():
 
449
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
 
450
        if x == 0:
 
451
            return True
 
452
        elif x == 127:
 
453
            continue
 
454
        else:
 
455
            break
 
456
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
 
457
    return False
 
458
                          
 
459
 
 
460
def get_text_message(infotext, ignoreline = "default"):
 
461
    import tempfile
 
462
    
 
463
    if ignoreline == "default":
 
464
        ignoreline = "-- This line and the following will be ignored --"
 
465
        
 
466
    try:
 
467
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
468
        msgfile = os.close(tmp_fileno)
 
469
        if infotext is not None and infotext != "":
 
470
            hasinfo = True
 
471
            msgfile = file(msgfilename, "w")
 
472
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
473
            msgfile.close()
 
474
        else:
 
475
            hasinfo = False
 
476
 
 
477
        if not _run_editor(msgfilename):
 
478
            return None
 
479
        
 
480
        started = False
 
481
        msg = []
 
482
        lastline, nlines = 0, 0
 
483
        for line in file(msgfilename, "r"):
 
484
            stripped_line = line.strip()
 
485
            # strip empty line before the log message starts
 
486
            if not started:
 
487
                if stripped_line != "":
 
488
                    started = True
 
489
                else:
 
490
                    continue
 
491
            # check for the ignore line only if there
 
492
            # is additional information at the end
 
493
            if hasinfo and stripped_line == ignoreline:
 
494
                break
 
495
            nlines += 1
 
496
            # keep track of the last line that had some content
 
497
            if stripped_line != "":
 
498
                lastline = nlines
 
499
            msg.append(line)
 
500
            
 
501
        if len(msg) == 0:
 
502
            return None
 
503
        # delete empty lines at the end
 
504
        del msg[lastline:]
 
505
        # add a newline at the end, if needed
 
506
        if not msg[-1].endswith("\n"):
 
507
            return "%s%s" % ("".join(msg), "\n")
 
508
        else:
 
509
            return "".join(msg)
 
510
    finally:
 
511
        # delete the msg file in any case
 
512
        try: os.unlink(msgfilename)
 
513
        except IOError: pass