← 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-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

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, sys
 
19
import os, types, re, time, errno
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
 
from bzrlib.errors import BzrError
23
 
from bzrlib.trace import mutter
 
22
from errors import bailout, BzrError
 
23
from 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 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):
59
56
    elif S_ISLNK(mode):
60
57
        return 'symlink'
61
58
    else:
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
 
 
 
59
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
101
60
 
102
61
 
103
62
 
118
77
        return False
119
78
 
120
79
 
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
 
 
140
80
def pumpfile(fromfile, tofile):
141
81
    """Copy contents of one file to another."""
142
82
    tofile.write(fromfile.read())
144
84
 
145
85
def uuid():
146
86
    """Return a new UUID"""
 
87
    
 
88
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
89
    ## Linux, but we need something portable for other systems;
 
90
    ## preferably an implementation in Python.
147
91
    try:
148
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
92
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
149
93
    except IOError:
150
94
        return chomp(os.popen('uuidgen').readline())
151
95
 
152
96
 
 
97
def chomp(s):
 
98
    if s and (s[-1] == '\n'):
 
99
        return s[:-1]
 
100
    else:
 
101
        return s
 
102
 
 
103
 
153
104
def sha_file(f):
154
105
    import sha
 
106
    ## TODO: Maybe read in chunks to handle big files
155
107
    if hasattr(f, 'tell'):
156
108
        assert f.tell() == 0
157
109
    s = sha.new()
158
 
    BUFSIZE = 128<<10
159
 
    while True:
160
 
        b = f.read(BUFSIZE)
161
 
        if not b:
162
 
            break
163
 
        s.update(b)
 
110
    s.update(f.read())
164
111
    return s.hexdigest()
165
112
 
166
113
 
182
129
            'sha1': s.hexdigest()}
183
130
 
184
131
 
185
 
def config_dir():
186
 
    """Return per-user configuration directory.
187
 
 
188
 
    By default this is ~/.bzr.conf/
189
 
    
190
 
    TODO: Global option --config-dir to override this.
191
 
    """
192
 
    return os.path.expanduser("~/.bzr.conf")
193
 
 
194
 
 
195
132
def _auto_user_id():
196
133
    """Calculate automatic user identification.
197
134
 
218
155
            realname = gecos
219
156
        else:
220
157
            realname = gecos[:comma]
221
 
        if not realname:
222
 
            realname = username
223
158
 
224
159
    except ImportError:
 
160
        realname = ''
225
161
        import getpass
226
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
162
        username = getpass.getuser().decode(bzrlib.user_encoding)
227
163
 
228
 
    return realname, (username + '@' + socket.gethostname())
 
164
    return realname, (username + '@' + os.gethostname())
229
165
 
230
166
 
231
167
def _get_user_id():
232
 
    """Return the full user id from a file or environment variable.
233
 
 
234
 
    TODO: Allow taking this from a file in the branch directory too
235
 
    for per-branch ids."""
236
168
    v = os.environ.get('BZREMAIL')
237
169
    if v:
238
170
        return v.decode(bzrlib.user_encoding)
239
171
    
240
172
    try:
241
 
        return (open(os.path.join(config_dir(), "email"))
 
173
        return (open(os.path.expanduser("~/.bzr.email"))
242
174
                .read()
243
175
                .decode(bzrlib.user_encoding)
244
176
                .rstrip("\r\n"))
245
 
    except IOError, e:
246
 
        if e.errno != errno.ENOENT:
 
177
    except OSError, e:
 
178
        if e.errno != ENOENT:
247
179
            raise e
248
180
 
249
181
    v = os.environ.get('EMAIL')
259
191
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
260
192
 
261
193
    TODO: Check it's reasonably well-formed.
 
194
 
 
195
    TODO: Allow taking it from a dotfile to help people on windows
 
196
           who can't easily set variables.
262
197
    """
263
198
    v = _get_user_id()
264
199
    if v:
278
213
    if e:
279
214
        m = _EMAIL_RE.search(e)
280
215
        if not m:
281
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
216
            bailout("%r doesn't seem to contain a reasonable email address" % e)
282
217
        return m.group(0)
283
218
 
284
219
    return _auto_user_id()[1]
287
222
 
288
223
def compare_files(a, b):
289
224
    """Returns true if equal in contents"""
 
225
    # TODO: don't read the whole thing in one go.
290
226
    BUFSIZE = 4096
291
227
    while True:
292
228
        ai = a.read(BUFSIZE)
326
262
        tt = time.localtime(t)
327
263
        offset = local_time_offset(t)
328
264
    else:
329
 
        raise BzrError("unsupported timezone format %r",
 
265
        bailout("unsupported timezone format %r",
330
266
                ['options are "utc", "original", "local"'])
331
267
 
332
268
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
345
281
 
346
282
if hasattr(os, 'urandom'): # python 2.4 and later
347
283
    rand_bytes = os.urandom
348
 
elif sys.platform == 'linux2':
349
 
    rand_bytes = file('/dev/urandom', 'rb').read
350
284
else:
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
 
285
    # FIXME: No good on non-Linux
 
286
    _rand_file = file('/dev/urandom', 'rb')
 
287
    rand_bytes = _rand_file.read
359
288
 
360
289
 
361
290
## TODO: We could later have path objects that remember their list
375
304
    >>> splitpath('a/../b')
376
305
    Traceback (most recent call last):
377
306
    ...
378
 
    BzrError: sorry, '..' not allowed in path
 
307
    BzrError: ("sorry, '..' not allowed in path", [])
379
308
    """
380
309
    assert isinstance(p, types.StringTypes)
381
 
 
382
 
    # split on either delimiter because people might use either on
383
 
    # Windows
384
 
    ps = re.split(r'[\\/]', p)
385
 
 
386
 
    rps = []
 
310
    ps = [f for f in p.split('/') if (f != '.' and f != '')]
387
311
    for f in ps:
388
312
        if f == '..':
389
 
            raise BzrError("sorry, %r not allowed in path" % f)
390
 
        elif (f == '.') or (f == ''):
391
 
            pass
392
 
        else:
393
 
            rps.append(f)
394
 
    return rps
 
313
            bailout("sorry, %r not allowed in path" % f)
 
314
    return ps
395
315
 
396
316
def joinpath(p):
397
317
    assert isinstance(p, list)
398
318
    for f in p:
399
319
        if (f == '..') or (f == None) or (f == ''):
400
 
            raise BzrError("sorry, %r not allowed in path" % f)
401
 
    return os.path.join(*p)
 
320
            bailout("sorry, %r not allowed in path" % f)
 
321
    return '/'.join(p)
402
322
 
403
323
 
404
324
def appendpath(p1, p2):
405
325
    if p1 == '':
406
326
        return p2
407
327
    else:
408
 
        return os.path.join(p1, p2)
 
328
        return p1 + '/' + p2
409
329
    
410
330
 
411
331
def extern_command(cmd, ignore_errors = False):
412
332
    mutter('external command: %s' % `cmd`)
413
333
    if os.system(cmd):
414
334
        if not ignore_errors:
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
 
335
            bailout('command failed')
 
336