~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-30 22:27:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050330222717-027b5837127b938d
experiment with new nested inventory file format
not used by default yet

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, types
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
24
 
import bzrlib
 
22
from errors import bailout
25
23
 
26
24
def make_readonly(filename):
27
25
    """Make a filename read-only."""
37
35
    os.chmod(filename, mod)
38
36
 
39
37
 
40
 
_QUOTE_RE = None
41
 
 
42
 
 
 
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
43
39
def quotefn(f):
44
 
    """Return a quoted filename filename
45
 
 
46
 
    This previously used backslash quoting, but that works poorly on
47
 
    Windows."""
48
 
    # TODO: I'm not really sure this is the best format either.x
49
 
    global _QUOTE_RE
50
 
    if _QUOTE_RE == None:
51
 
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
52
 
        
53
 
    if _QUOTE_RE.search(f):
54
 
        return '"' + f + '"'
55
 
    else:
56
 
        return f
 
40
    """Return shell-quoted filename"""
 
41
    ## We could be a bit more terse by using double-quotes etc
 
42
    f = _QUOTE_RE.sub(r'\\\1', f)
 
43
    if f[0] == '~':
 
44
        f[0:1] = r'\~' 
 
45
    return f
57
46
 
58
47
 
59
48
def file_kind(f):
65
54
    elif S_ISLNK(mode):
66
55
        return 'symlink'
67
56
    else:
68
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
69
 
 
70
 
 
71
 
def kind_marker(kind):
72
 
    if kind == 'file':
73
 
        return ''
74
 
    elif kind == 'directory':
75
 
        return '/'
76
 
    elif kind == 'symlink':
77
 
        return '@'
78
 
    else:
79
 
        raise BzrError('invalid file kind %r' % kind)
80
 
 
81
 
 
82
 
 
83
 
def backup_file(fn):
84
 
    """Copy a file to a backup.
85
 
 
86
 
    Backups are named in GNU-style, with a ~ suffix.
87
 
 
88
 
    If the file is already a backup, it's not copied.
89
 
    """
90
 
    import os
91
 
    if fn[-1] == '~':
92
 
        return
93
 
    bfn = fn + '~'
94
 
 
95
 
    inf = file(fn, 'rb')
96
 
    try:
97
 
        content = inf.read()
98
 
    finally:
99
 
        inf.close()
100
 
    
101
 
    outf = file(bfn, 'wb')
102
 
    try:
103
 
        outf.write(content)
104
 
    finally:
105
 
        outf.close()
106
 
 
107
 
def rename(path_from, path_to):
108
 
    """Basically the same as os.rename() just special for win32"""
109
 
    if sys.platform == 'win32':
110
 
        try:
111
 
            os.remove(path_to)
112
 
        except OSError, e:
113
 
            if e.errno != e.ENOENT:
114
 
                raise
115
 
    os.rename(path_from, path_to)
116
 
 
117
 
 
 
57
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
118
58
 
119
59
 
120
60
 
135
75
        return False
136
76
 
137
77
 
138
 
def is_inside(dir, fname):
139
 
    """True if fname is inside dir.
140
 
    
141
 
    The parameters should typically be passed to os.path.normpath first, so
142
 
    that . and .. and repeated slashes are eliminated, and the separators
143
 
    are canonical for the platform.
144
 
    
145
 
    The empty string as a dir name is taken as top-of-tree and matches 
146
 
    everything.
147
 
    
148
 
    >>> is_inside('src', 'src/foo.c')
149
 
    True
150
 
    >>> is_inside('src', 'srccontrol')
151
 
    False
152
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
153
 
    True
154
 
    >>> is_inside('foo.c', 'foo.c')
155
 
    True
156
 
    >>> is_inside('foo.c', '')
157
 
    False
158
 
    >>> is_inside('', 'foo.c')
159
 
    True
160
 
    """
161
 
    # XXX: Most callers of this can actually do something smarter by 
162
 
    # looking at the inventory
163
 
    if dir == fname:
164
 
        return True
165
 
    
166
 
    if dir == '':
167
 
        return True
168
 
    
169
 
    if dir[-1] != os.sep:
170
 
        dir += os.sep
171
 
    
172
 
    return fname.startswith(dir)
173
 
 
174
 
 
175
 
def is_inside_any(dir_list, fname):
176
 
    """True if fname is inside any of given dirs."""
177
 
    for dirname in dir_list:
178
 
        if is_inside(dirname, fname):
179
 
            return True
180
 
    else:
181
 
        return False
182
 
 
183
 
 
184
78
def pumpfile(fromfile, tofile):
185
79
    """Copy contents of one file to another."""
186
80
    tofile.write(fromfile.read())
188
82
 
189
83
def uuid():
190
84
    """Return a new UUID"""
 
85
    
 
86
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
87
    ## Linux, but we need something portable for other systems;
 
88
    ## preferably an implementation in Python.
191
89
    try:
192
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
90
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
193
91
    except IOError:
194
92
        return chomp(os.popen('uuidgen').readline())
195
93
 
196
94
 
 
95
def chomp(s):
 
96
    if s and (s[-1] == '\n'):
 
97
        return s[:-1]
 
98
    else:
 
99
        return s
 
100
 
 
101
 
197
102
def sha_file(f):
198
103
    import sha
 
104
    ## TODO: Maybe read in chunks to handle big files
199
105
    if hasattr(f, 'tell'):
200
106
        assert f.tell() == 0
201
107
    s = sha.new()
202
 
    BUFSIZE = 128<<10
203
 
    while True:
204
 
        b = f.read(BUFSIZE)
205
 
        if not b:
206
 
            break
207
 
        s.update(b)
 
108
    s.update(f.read())
208
109
    return s.hexdigest()
209
110
 
210
111
 
226
127
            'sha1': s.hexdigest()}
227
128
 
228
129
 
229
 
def config_dir():
230
 
    """Return per-user configuration directory.
231
 
 
232
 
    By default this is ~/.bzr.conf/
233
 
    
234
 
    TODO: Global option --config-dir to override this.
235
 
    """
236
 
    return os.path.expanduser("~/.bzr.conf")
237
 
 
238
 
 
239
 
def _auto_user_id():
240
 
    """Calculate automatic user identification.
241
 
 
242
 
    Returns (realname, email).
243
 
 
244
 
    Only used when none is set in the environment or the id file.
245
 
 
246
 
    This previously used the FQDN as the default domain, but that can
247
 
    be very slow on machines where DNS is broken.  So now we simply
248
 
    use the hostname.
249
 
    """
 
130
 
 
131
def username():
 
132
    """Return email-style username.
 
133
 
 
134
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
135
 
 
136
    :todo: Check it's reasonably well-formed.
 
137
 
 
138
    :todo: Allow taking it from a dotfile to help people on windows
 
139
           who can't easily set variables.
 
140
 
 
141
    :todo: Cope without pwd module, which is only on unix. 
 
142
    """
 
143
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
144
    if e: return e
 
145
 
250
146
    import socket
251
 
 
252
 
    # XXX: Any good way to get real user name on win32?
253
 
 
 
147
    
254
148
    try:
255
149
        import pwd
256
150
        uid = os.getuid()
257
151
        w = pwd.getpwuid(uid)
258
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
 
        username = w.pw_name.decode(bzrlib.user_encoding)
 
152
        gecos = w.pw_gecos
260
153
        comma = gecos.find(',')
261
154
        if comma == -1:
262
155
            realname = gecos
263
156
        else:
264
157
            realname = gecos[:comma]
265
 
        if not realname:
266
 
            realname = username
267
 
 
 
158
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
268
159
    except ImportError:
269
 
        import getpass
270
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
271
 
 
272
 
    return realname, (username + '@' + socket.gethostname())
273
 
 
274
 
 
275
 
def _get_user_id(branch):
276
 
    """Return the full user id from a file or environment variable.
277
 
 
278
 
    e.g. "John Hacker <jhacker@foo.org>"
279
 
 
280
 
    branch
281
 
        A branch to use for a per-branch configuration, or None.
282
 
 
283
 
    The following are searched in order:
284
 
 
285
 
    1. $BZREMAIL
286
 
    2. .bzr/email for this branch.
287
 
    3. ~/.bzr.conf/email
288
 
    4. $EMAIL
289
 
    """
290
 
    v = os.environ.get('BZREMAIL')
291
 
    if v:
292
 
        return v.decode(bzrlib.user_encoding)
293
 
 
294
 
    if branch:
295
 
        try:
296
 
            return (branch.controlfile("email", "r") 
297
 
                    .read()
298
 
                    .decode(bzrlib.user_encoding)
299
 
                    .rstrip("\r\n"))
300
 
        except IOError, e:
301
 
            if e.errno != errno.ENOENT:
302
 
                raise
303
 
        except BzrError, e:
304
 
            pass
305
 
    
306
 
    try:
307
 
        return (open(os.path.join(config_dir(), "email"))
308
 
                .read()
309
 
                .decode(bzrlib.user_encoding)
310
 
                .rstrip("\r\n"))
311
 
    except IOError, e:
312
 
        if e.errno != errno.ENOENT:
313
 
            raise e
314
 
 
315
 
    v = os.environ.get('EMAIL')
316
 
    if v:
317
 
        return v.decode(bzrlib.user_encoding)
318
 
    else:    
319
 
        return None
320
 
 
321
 
 
322
 
def username(branch):
323
 
    """Return email-style username.
324
 
 
325
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
326
 
 
327
 
    TODO: Check it's reasonably well-formed.
328
 
    """
329
 
    v = _get_user_id(branch)
330
 
    if v:
331
 
        return v
332
 
    
333
 
    name, email = _auto_user_id()
334
 
    if name:
335
 
        return '%s <%s>' % (name, email)
336
 
    else:
337
 
        return email
338
 
 
339
 
 
340
 
def user_email(branch):
 
160
        pass
 
161
 
 
162
    import getpass, socket
 
163
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
164
 
 
165
 
 
166
def user_email():
341
167
    """Return just the email component of a username."""
342
 
    e = _get_user_id(branch)
 
168
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
343
169
    if e:
 
170
        import re
344
171
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
345
172
        if not m:
346
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
173
            bailout('%r is not a reasonable email address' % e)
347
174
        return m.group(0)
348
175
 
349
 
    return _auto_user_id()[1]
 
176
 
 
177
    import getpass, socket
 
178
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
179
 
350
180
    
351
181
 
352
182
 
353
183
def compare_files(a, b):
354
184
    """Returns true if equal in contents"""
 
185
    # TODO: don't read the whole thing in one go.
355
186
    BUFSIZE = 4096
356
187
    while True:
357
188
        ai = a.read(BUFSIZE)
366
197
def local_time_offset(t=None):
367
198
    """Return offset of local zone from GMT, either at present or at time t."""
368
199
    # python2.3 localtime() can't take None
369
 
    if t == None:
 
200
    if t is None:
370
201
        t = time.time()
371
202
        
372
203
    if time.localtime(t).tm_isdst and time.daylight:
378
209
def format_date(t, offset=0, timezone='original'):
379
210
    ## TODO: Perhaps a global option to use either universal or local time?
380
211
    ## Or perhaps just let people set $TZ?
 
212
    import time
 
213
    
381
214
    assert isinstance(t, float)
382
215
    
383
216
    if timezone == 'utc':
391
224
        tt = time.localtime(t)
392
225
        offset = local_time_offset(t)
393
226
    else:
394
 
        raise BzrError("unsupported timezone format %r" % timezone,
395
 
                       ['options are "utc", "original", "local"'])
 
227
        bailout("unsupported timezone format %r",
 
228
                ['options are "utc", "original", "local"'])
396
229
 
397
230
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
231
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
410
243
 
411
244
if hasattr(os, 'urandom'): # python 2.4 and later
412
245
    rand_bytes = os.urandom
413
 
elif sys.platform == 'linux2':
414
 
    rand_bytes = file('/dev/urandom', 'rb').read
415
246
else:
416
 
    # not well seeded, but better than nothing
417
 
    def rand_bytes(n):
418
 
        import random
419
 
        s = ''
420
 
        while n:
421
 
            s += chr(random.randint(0, 255))
422
 
            n -= 1
423
 
        return s
 
247
    # FIXME: No good on non-Linux
 
248
    _rand_file = file('/dev/urandom', 'rb')
 
249
    rand_bytes = _rand_file.read
424
250
 
425
251
 
426
252
## TODO: We could later have path objects that remember their list
440
266
    >>> splitpath('a/../b')
441
267
    Traceback (most recent call last):
442
268
    ...
443
 
    BzrError: sorry, '..' not allowed in path
 
269
    BzrError: ("sorry, '..' not allowed in path", [])
444
270
    """
445
271
    assert isinstance(p, types.StringTypes)
446
 
 
447
 
    # split on either delimiter because people might use either on
448
 
    # Windows
449
 
    ps = re.split(r'[\\/]', p)
450
 
 
451
 
    rps = []
 
272
    ps = [f for f in p.split('/') if f != '.']
452
273
    for f in ps:
453
274
        if f == '..':
454
 
            raise BzrError("sorry, %r not allowed in path" % f)
455
 
        elif (f == '.') or (f == ''):
456
 
            pass
457
 
        else:
458
 
            rps.append(f)
459
 
    return rps
 
275
            bailout("sorry, %r not allowed in path" % f)
 
276
    return ps
460
277
 
461
278
def joinpath(p):
462
279
    assert isinstance(p, list)
463
280
    for f in p:
464
 
        if (f == '..') or (f == None) or (f == ''):
465
 
            raise BzrError("sorry, %r not allowed in path" % f)
466
 
    return os.path.join(*p)
 
281
        if (f == '..') or (f is None) or (f == ''):
 
282
            bailout("sorry, %r not allowed in path" % f)
 
283
    return '/'.join(p)
467
284
 
468
285
 
469
286
def appendpath(p1, p2):
470
287
    if p1 == '':
471
288
        return p2
472
289
    else:
473
 
        return os.path.join(p1, p2)
 
290
        return p1 + '/' + p2
474
291
    
475
292
 
476
293
def extern_command(cmd, ignore_errors = False):
477
294
    mutter('external command: %s' % `cmd`)
478
295
    if os.system(cmd):
479
296
        if not ignore_errors:
480
 
            raise BzrError('command failed')
481
 
 
482
 
 
483
 
def _read_config_value(name):
484
 
    """Read a config value from the file ~/.bzr.conf/<name>
485
 
    Return None if the file does not exist"""
486
 
    try:
487
 
        f = file(os.path.join(config_dir(), name), "r")
488
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
489
 
    except IOError, e:
490
 
        if e.errno == errno.ENOENT:
491
 
            return None
492
 
        raise
493
 
 
494
 
 
495
 
def _get_editor():
496
 
    """Return a sequence of possible editor binaries for the current platform"""
497
 
    e = _read_config_value("editor")
498
 
    if e is not None:
499
 
        yield e
500
 
        
501
 
    if os.name == "windows":
502
 
        yield "notepad.exe"
503
 
    elif os.name == "posix":
504
 
        try:
505
 
            yield os.environ["EDITOR"]
506
 
        except KeyError:
507
 
            yield "/usr/bin/vi"
508
 
 
509
 
 
510
 
def _run_editor(filename):
511
 
    """Try to execute an editor to edit the commit message. Returns True on success,
512
 
    False on failure"""
513
 
    for e in _get_editor():
514
 
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
515
 
        if x == 0:
516
 
            return True
517
 
        elif x == 127:
518
 
            continue
519
 
        else:
520
 
            break
521
 
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
522
 
    return False
523
 
                          
524
 
 
525
 
def get_text_message(infotext, ignoreline = "default"):
526
 
    import tempfile
527
 
    
528
 
    if ignoreline == "default":
529
 
        ignoreline = "-- This line and the following will be ignored --"
530
 
        
531
 
    try:
532
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
533
 
        msgfile = os.close(tmp_fileno)
534
 
        if infotext is not None and infotext != "":
535
 
            hasinfo = True
536
 
            msgfile = file(msgfilename, "w")
537
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
538
 
            msgfile.close()
539
 
        else:
540
 
            hasinfo = False
541
 
 
542
 
        if not _run_editor(msgfilename):
543
 
            return None
544
 
        
545
 
        started = False
546
 
        msg = []
547
 
        lastline, nlines = 0, 0
548
 
        for line in file(msgfilename, "r"):
549
 
            stripped_line = line.strip()
550
 
            # strip empty line before the log message starts
551
 
            if not started:
552
 
                if stripped_line != "":
553
 
                    started = True
554
 
                else:
555
 
                    continue
556
 
            # check for the ignore line only if there
557
 
            # is additional information at the end
558
 
            if hasinfo and stripped_line == ignoreline:
559
 
                break
560
 
            nlines += 1
561
 
            # keep track of the last line that had some content
562
 
            if stripped_line != "":
563
 
                lastline = nlines
564
 
            msg.append(line)
565
 
            
566
 
        if len(msg) == 0:
567
 
            return None
568
 
        # delete empty lines at the end
569
 
        del msg[lastline:]
570
 
        # add a newline at the end, if needed
571
 
        if not msg[-1].endswith("\n"):
572
 
            return "%s%s" % ("".join(msg), "\n")
573
 
        else:
574
 
            return "".join(msg)
575
 
    finally:
576
 
        # delete the msg file in any case
577
 
        try: os.unlink(msgfilename)
578
 
        except IOError: pass
 
297
            bailout('command failed')
 
298