~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:
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
 
 
101
 
def rename(path_from, path_to):
102
 
    """Basically the same as os.rename() just special for win32"""
103
 
    if sys.platform == 'win32':
104
 
        try:
105
 
            os.remove(path_to)
106
 
        except OSError, e:
107
 
            if e.errno != e.ENOENT:
108
 
                raise
109
 
    os.rename(path_from, path_to)
110
 
 
111
 
 
 
59
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
112
60
 
113
61
 
114
62
 
129
77
        return False
130
78
 
131
79
 
132
 
def is_inside(dir, fname):
133
 
    """True if fname is inside dir.
134
 
    """
135
 
    return os.path.commonprefix([dir, fname]) == dir
136
 
 
137
 
 
138
 
def is_inside_any(dir_list, fname):
139
 
    """True if fname is inside any of given dirs."""
140
 
    # quick scan for perfect match
141
 
    if fname in dir_list:
142
 
        return True
143
 
    
144
 
    for dirname in dir_list:
145
 
        if is_inside(dirname, fname):
146
 
            return True
147
 
    else:
148
 
        return False
149
 
 
150
 
 
151
80
def pumpfile(fromfile, tofile):
152
81
    """Copy contents of one file to another."""
153
82
    tofile.write(fromfile.read())
155
84
 
156
85
def uuid():
157
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.
158
91
    try:
159
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
92
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
160
93
    except IOError:
161
94
        return chomp(os.popen('uuidgen').readline())
162
95
 
163
96
 
 
97
def chomp(s):
 
98
    if s and (s[-1] == '\n'):
 
99
        return s[:-1]
 
100
    else:
 
101
        return s
 
102
 
 
103
 
164
104
def sha_file(f):
165
105
    import sha
 
106
    ## TODO: Maybe read in chunks to handle big files
166
107
    if hasattr(f, 'tell'):
167
108
        assert f.tell() == 0
168
109
    s = sha.new()
169
 
    BUFSIZE = 128<<10
170
 
    while True:
171
 
        b = f.read(BUFSIZE)
172
 
        if not b:
173
 
            break
174
 
        s.update(b)
 
110
    s.update(f.read())
175
111
    return s.hexdigest()
176
112
 
177
113
 
193
129
            'sha1': s.hexdigest()}
194
130
 
195
131
 
196
 
def config_dir():
197
 
    """Return per-user configuration directory.
198
 
 
199
 
    By default this is ~/.bzr.conf/
200
 
    
201
 
    TODO: Global option --config-dir to override this.
202
 
    """
203
 
    return os.path.expanduser("~/.bzr.conf")
204
 
 
205
 
 
206
132
def _auto_user_id():
207
133
    """Calculate automatic user identification.
208
134
 
229
155
            realname = gecos
230
156
        else:
231
157
            realname = gecos[:comma]
232
 
        if not realname:
233
 
            realname = username
234
158
 
235
159
    except ImportError:
 
160
        realname = ''
236
161
        import getpass
237
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
162
        username = getpass.getuser().decode(bzrlib.user_encoding)
238
163
 
239
 
    return realname, (username + '@' + socket.gethostname())
 
164
    return realname, (username + '@' + os.gethostname())
240
165
 
241
166
 
242
167
def _get_user_id():
243
 
    """Return the full user id from a file or environment variable.
244
 
 
245
 
    TODO: Allow taking this from a file in the branch directory too
246
 
    for per-branch ids."""
247
168
    v = os.environ.get('BZREMAIL')
248
169
    if v:
249
170
        return v.decode(bzrlib.user_encoding)
250
171
    
251
172
    try:
252
 
        return (open(os.path.join(config_dir(), "email"))
 
173
        return (open(os.path.expanduser("~/.bzr.email"))
253
174
                .read()
254
175
                .decode(bzrlib.user_encoding)
255
176
                .rstrip("\r\n"))
256
 
    except IOError, e:
257
 
        if e.errno != errno.ENOENT:
 
177
    except OSError, e:
 
178
        if e.errno != ENOENT:
258
179
            raise e
259
180
 
260
181
    v = os.environ.get('EMAIL')
270
191
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
271
192
 
272
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.
273
197
    """
274
198
    v = _get_user_id()
275
199
    if v:
289
213
    if e:
290
214
        m = _EMAIL_RE.search(e)
291
215
        if not m:
292
 
            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)
293
217
        return m.group(0)
294
218
 
295
219
    return _auto_user_id()[1]
298
222
 
299
223
def compare_files(a, b):
300
224
    """Returns true if equal in contents"""
 
225
    # TODO: don't read the whole thing in one go.
301
226
    BUFSIZE = 4096
302
227
    while True:
303
228
        ai = a.read(BUFSIZE)
337
262
        tt = time.localtime(t)
338
263
        offset = local_time_offset(t)
339
264
    else:
340
 
        raise BzrError("unsupported timezone format %r",
 
265
        bailout("unsupported timezone format %r",
341
266
                ['options are "utc", "original", "local"'])
342
267
 
343
268
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
356
281
 
357
282
if hasattr(os, 'urandom'): # python 2.4 and later
358
283
    rand_bytes = os.urandom
359
 
elif sys.platform == 'linux2':
360
 
    rand_bytes = file('/dev/urandom', 'rb').read
361
284
else:
362
 
    # not well seeded, but better than nothing
363
 
    def rand_bytes(n):
364
 
        import random
365
 
        s = ''
366
 
        while n:
367
 
            s += chr(random.randint(0, 255))
368
 
            n -= 1
369
 
        return s
 
285
    # FIXME: No good on non-Linux
 
286
    _rand_file = file('/dev/urandom', 'rb')
 
287
    rand_bytes = _rand_file.read
370
288
 
371
289
 
372
290
## TODO: We could later have path objects that remember their list
386
304
    >>> splitpath('a/../b')
387
305
    Traceback (most recent call last):
388
306
    ...
389
 
    BzrError: sorry, '..' not allowed in path
 
307
    BzrError: ("sorry, '..' not allowed in path", [])
390
308
    """
391
309
    assert isinstance(p, types.StringTypes)
392
 
 
393
 
    # split on either delimiter because people might use either on
394
 
    # Windows
395
 
    ps = re.split(r'[\\/]', p)
396
 
 
397
 
    rps = []
 
310
    ps = [f for f in p.split('/') if (f != '.' and f != '')]
398
311
    for f in ps:
399
312
        if f == '..':
400
 
            raise BzrError("sorry, %r not allowed in path" % f)
401
 
        elif (f == '.') or (f == ''):
402
 
            pass
403
 
        else:
404
 
            rps.append(f)
405
 
    return rps
 
313
            bailout("sorry, %r not allowed in path" % f)
 
314
    return ps
406
315
 
407
316
def joinpath(p):
408
317
    assert isinstance(p, list)
409
318
    for f in p:
410
319
        if (f == '..') or (f == None) or (f == ''):
411
 
            raise BzrError("sorry, %r not allowed in path" % f)
412
 
    return os.path.join(*p)
 
320
            bailout("sorry, %r not allowed in path" % f)
 
321
    return '/'.join(p)
413
322
 
414
323
 
415
324
def appendpath(p1, p2):
416
325
    if p1 == '':
417
326
        return p2
418
327
    else:
419
 
        return os.path.join(p1, p2)
 
328
        return p1 + '/' + p2
420
329
    
421
330
 
422
331
def extern_command(cmd, ignore_errors = False):
423
332
    mutter('external command: %s' % `cmd`)
424
333
    if os.system(cmd):
425
334
        if not ignore_errors:
426
 
            raise BzrError('command failed')
427
 
 
428
 
 
429
 
def _read_config_value(name):
430
 
    """Read a config value from the file ~/.bzr.conf/<name>
431
 
    Return None if the file does not exist"""
432
 
    try:
433
 
        f = file(os.path.join(config_dir(), name), "r")
434
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
435
 
    except IOError, e:
436
 
        if e.errno == errno.ENOENT:
437
 
            return None
438
 
        raise
439
 
 
440
 
 
441
 
def _get_editor():
442
 
    """Return a sequence of possible editor binaries for the current platform"""
443
 
    e = _read_config_value("editor")
444
 
    if e is not None:
445
 
        yield e
446
 
        
447
 
    if os.name == "windows":
448
 
        yield "notepad.exe"
449
 
    elif os.name == "posix":
450
 
        try:
451
 
            yield os.environ["EDITOR"]
452
 
        except KeyError:
453
 
            yield "/usr/bin/vi"
454
 
 
455
 
 
456
 
def _run_editor(filename):
457
 
    """Try to execute an editor to edit the commit message. Returns True on success,
458
 
    False on failure"""
459
 
    for e in _get_editor():
460
 
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
461
 
        if x == 0:
462
 
            return True
463
 
        elif x == 127:
464
 
            continue
465
 
        else:
466
 
            break
467
 
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
468
 
    return False
469
 
                          
470
 
 
471
 
def get_text_message(infotext, ignoreline = "default"):
472
 
    import tempfile
473
 
    
474
 
    if ignoreline == "default":
475
 
        ignoreline = "-- This line and the following will be ignored --"
476
 
        
477
 
    try:
478
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
479
 
        msgfile = os.close(tmp_fileno)
480
 
        if infotext is not None and infotext != "":
481
 
            hasinfo = True
482
 
            msgfile = file(msgfilename, "w")
483
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
484
 
            msgfile.close()
485
 
        else:
486
 
            hasinfo = False
487
 
 
488
 
        if not _run_editor(msgfilename):
489
 
            return None
490
 
        
491
 
        started = False
492
 
        msg = []
493
 
        lastline, nlines = 0, 0
494
 
        for line in file(msgfilename, "r"):
495
 
            stripped_line = line.strip()
496
 
            # strip empty line before the log message starts
497
 
            if not started:
498
 
                if stripped_line != "":
499
 
                    started = True
500
 
                else:
501
 
                    continue
502
 
            # check for the ignore line only if there
503
 
            # is additional information at the end
504
 
            if hasinfo and stripped_line == ignoreline:
505
 
                break
506
 
            nlines += 1
507
 
            # keep track of the last line that had some content
508
 
            if stripped_line != "":
509
 
                lastline = nlines
510
 
            msg.append(line)
511
 
            
512
 
        if len(msg) == 0:
513
 
            return None
514
 
        # delete empty lines at the end
515
 
        del msg[lastline:]
516
 
        # add a newline at the end, if needed
517
 
        if not msg[-1].endswith("\n"):
518
 
            return "%s%s" % ("".join(msg), "\n")
519
 
        else:
520
 
            return "".join(msg)
521
 
    finally:
522
 
        # delete the msg file in any case
523
 
        try: os.unlink(msgfilename)
524
 
        except IOError: pass
 
335
            bailout('command failed')
 
336