← 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-08-02 23:14:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050802231441-d738a6e6ffd03c3e
- new error RevisionNotPresent

- raise this when trying to fetch a revision that's mentioned but not 
  in the revision store

- Store raises an IndexError from getitem method if key is not found

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
19
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):
38
38
 
39
39
 
40
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
41
 
 
42
_SLASH_RE = re.compile(r'[\\/]+')
 
43
 
41
44
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
 
45
    """Return a quoted filename filename
 
46
 
 
47
    This previously used backslash quoting, but that works poorly on
 
48
    Windows."""
 
49
    # TODO: I'm not really sure this is the best format either.x
 
50
    if _QUOTE_RE.search(f):
 
51
        return '"' + f + '"'
 
52
    else:
 
53
        return f
48
54
 
49
55
 
50
56
def file_kind(f):
56
62
    elif S_ISLNK(mode):
57
63
        return 'symlink'
58
64
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
 
65
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
66
 
 
67
 
 
68
def kind_marker(kind):
 
69
    if kind == 'file':
 
70
        return ''
 
71
    elif kind == 'directory':
 
72
        return '/'
 
73
    elif kind == 'symlink':
 
74
        return '@'
 
75
    else:
 
76
        raise BzrError('invalid file kind %r' % kind)
 
77
 
 
78
 
 
79
 
 
80
def backup_file(fn):
 
81
    """Copy a file to a backup.
 
82
 
 
83
    Backups are named in GNU-style, with a ~ suffix.
 
84
 
 
85
    If the file is already a backup, it's not copied.
 
86
    """
 
87
    import os
 
88
    if fn[-1] == '~':
 
89
        return
 
90
    bfn = fn + '~'
 
91
 
 
92
    inf = file(fn, 'rb')
 
93
    try:
 
94
        content = inf.read()
 
95
    finally:
 
96
        inf.close()
 
97
    
 
98
    outf = file(bfn, 'wb')
 
99
    try:
 
100
        outf.write(content)
 
101
    finally:
 
102
        outf.close()
 
103
 
 
104
def rename(path_from, path_to):
 
105
    """Basically the same as os.rename() just special for win32"""
 
106
    if sys.platform == 'win32':
 
107
        try:
 
108
            os.remove(path_to)
 
109
        except OSError, e:
 
110
            if e.errno != e.ENOENT:
 
111
                raise
 
112
    os.rename(path_from, path_to)
 
113
 
 
114
 
60
115
 
61
116
 
62
117
 
77
132
        return False
78
133
 
79
134
 
 
135
def is_inside(dir, fname):
 
136
    """True if fname is inside dir.
 
137
    
 
138
    The parameters should typically be passed to os.path.normpath first, so
 
139
    that . and .. and repeated slashes are eliminated, and the separators
 
140
    are canonical for the platform.
 
141
    
 
142
    The empty string as a dir name is taken as top-of-tree and matches 
 
143
    everything.
 
144
    
 
145
    >>> is_inside('src', 'src/foo.c')
 
146
    True
 
147
    >>> is_inside('src', 'srccontrol')
 
148
    False
 
149
    >>> is_inside('src', 'src/a/a/a/foo.c')
 
150
    True
 
151
    >>> is_inside('foo.c', 'foo.c')
 
152
    True
 
153
    >>> is_inside('foo.c', '')
 
154
    False
 
155
    >>> is_inside('', 'foo.c')
 
156
    True
 
157
    """
 
158
    # XXX: Most callers of this can actually do something smarter by 
 
159
    # looking at the inventory
 
160
    if dir == fname:
 
161
        return True
 
162
    
 
163
    if dir == '':
 
164
        return True
 
165
    
 
166
    if dir[-1] != os.sep:
 
167
        dir += os.sep
 
168
    
 
169
    return fname.startswith(dir)
 
170
 
 
171
 
 
172
def is_inside_any(dir_list, fname):
 
173
    """True if fname is inside any of given dirs."""
 
174
    for dirname in dir_list:
 
175
        if is_inside(dirname, fname):
 
176
            return True
 
177
    else:
 
178
        return False
 
179
 
 
180
 
80
181
def pumpfile(fromfile, tofile):
81
182
    """Copy contents of one file to another."""
82
183
    tofile.write(fromfile.read())
218
319
    if e:
219
320
        m = _EMAIL_RE.search(e)
220
321
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
322
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
222
323
        return m.group(0)
223
324
 
224
325
    return _auto_user_id()[1]
266
367
        tt = time.localtime(t)
267
368
        offset = local_time_offset(t)
268
369
    else:
269
 
        bailout("unsupported timezone format %r",
270
 
                ['options are "utc", "original", "local"'])
 
370
        raise BzrError("unsupported timezone format %r" % timezone,
 
371
                       ['options are "utc", "original", "local"'])
271
372
 
272
373
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
374
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
315
416
    >>> splitpath('a/../b')
316
417
    Traceback (most recent call last):
317
418
    ...
318
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
419
    BzrError: sorry, '..' not allowed in path
319
420
    """
320
421
    assert isinstance(p, types.StringTypes)
321
422
 
326
427
    rps = []
327
428
    for f in ps:
328
429
        if f == '..':
329
 
            bailout("sorry, %r not allowed in path" % f)
 
430
            raise BzrError("sorry, %r not allowed in path" % f)
330
431
        elif (f == '.') or (f == ''):
331
432
            pass
332
433
        else:
337
438
    assert isinstance(p, list)
338
439
    for f in p:
339
440
        if (f == '..') or (f == None) or (f == ''):
340
 
            bailout("sorry, %r not allowed in path" % f)
 
441
            raise BzrError("sorry, %r not allowed in path" % f)
341
442
    return os.path.join(*p)
342
443
 
343
444
 
352
453
    mutter('external command: %s' % `cmd`)
353
454
    if os.system(cmd):
354
455
        if not ignore_errors:
355
 
            bailout('command failed')
356
 
 
 
456
            raise BzrError('command failed')
 
457
 
 
458
 
 
459
def _read_config_value(name):
 
460
    """Read a config value from the file ~/.bzr.conf/<name>
 
461
    Return None if the file does not exist"""
 
462
    try:
 
463
        f = file(os.path.join(config_dir(), name), "r")
 
464
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
 
465
    except IOError, e:
 
466
        if e.errno == errno.ENOENT:
 
467
            return None
 
468
        raise
 
469
 
 
470
 
 
471
def _get_editor():
 
472
    """Return a sequence of possible editor binaries for the current platform"""
 
473
    e = _read_config_value("editor")
 
474
    if e is not None:
 
475
        yield e
 
476
        
 
477
    if os.name == "windows":
 
478
        yield "notepad.exe"
 
479
    elif os.name == "posix":
 
480
        try:
 
481
            yield os.environ["EDITOR"]
 
482
        except KeyError:
 
483
            yield "/usr/bin/vi"
 
484
 
 
485
 
 
486
def _run_editor(filename):
 
487
    """Try to execute an editor to edit the commit message. Returns True on success,
 
488
    False on failure"""
 
489
    for e in _get_editor():
 
490
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
 
491
        if x == 0:
 
492
            return True
 
493
        elif x == 127:
 
494
            continue
 
495
        else:
 
496
            break
 
497
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
 
498
    return False
 
499
                          
 
500
 
 
501
def get_text_message(infotext, ignoreline = "default"):
 
502
    import tempfile
 
503
    
 
504
    if ignoreline == "default":
 
505
        ignoreline = "-- This line and the following will be ignored --"
 
506
        
 
507
    try:
 
508
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
509
        msgfile = os.close(tmp_fileno)
 
510
        if infotext is not None and infotext != "":
 
511
            hasinfo = True
 
512
            msgfile = file(msgfilename, "w")
 
513
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
514
            msgfile.close()
 
515
        else:
 
516
            hasinfo = False
 
517
 
 
518
        if not _run_editor(msgfilename):
 
519
            return None
 
520
        
 
521
        started = False
 
522
        msg = []
 
523
        lastline, nlines = 0, 0
 
524
        for line in file(msgfilename, "r"):
 
525
            stripped_line = line.strip()
 
526
            # strip empty line before the log message starts
 
527
            if not started:
 
528
                if stripped_line != "":
 
529
                    started = True
 
530
                else:
 
531
                    continue
 
532
            # check for the ignore line only if there
 
533
            # is additional information at the end
 
534
            if hasinfo and stripped_line == ignoreline:
 
535
                break
 
536
            nlines += 1
 
537
            # keep track of the last line that had some content
 
538
            if stripped_line != "":
 
539
                lastline = nlines
 
540
            msg.append(line)
 
541
            
 
542
        if len(msg) == 0:
 
543
            return None
 
544
        # delete empty lines at the end
 
545
        del msg[lastline:]
 
546
        # add a newline at the end, if needed
 
547
        if not msg[-1].endswith("\n"):
 
548
            return "%s%s" % ("".join(msg), "\n")
 
549
        else:
 
550
            return "".join(msg)
 
551
    finally:
 
552
        # delete the msg file in any case
 
553
        try: os.unlink(msgfilename)
 
554
        except IOError: pass