~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-06-22 06:37:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050622063743-e395f04c4db8977f
- move old blackbox code from testbzr into bzrlib.selftest.blackbox

Show diffs side-by-side

added added

removed removed

Lines of Context:
39
39
 
40
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
41
41
def quotefn(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
 
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
51
48
 
52
49
 
53
50
def file_kind(f):
74
71
 
75
72
 
76
73
 
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
 
 
101
 
 
102
 
 
103
 
 
104
74
def isdir(f):
105
75
    """True if f is an accessible directory."""
106
76
    try:
414
384
        if not ignore_errors:
415
385
            raise BzrError('command failed')
416
386
 
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