← 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-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

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, types
 
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
 
22
from bzrlib.errors import BzrError
 
23
from bzrlib.trace import mutter
 
24
import bzrlib
23
25
 
24
26
def make_readonly(filename):
25
27
    """Make a filename read-only."""
37
39
 
38
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
39
41
def quotefn(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
 
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
46
51
 
47
52
 
48
53
def file_kind(f):
54
59
    elif S_ISLNK(mode):
55
60
        return 'symlink'
56
61
    else:
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
 
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
 
58
101
 
59
102
 
60
103
 
75
118
        return False
76
119
 
77
120
 
 
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
 
78
140
def pumpfile(fromfile, tofile):
79
141
    """Copy contents of one file to another."""
80
142
    tofile.write(fromfile.read())
82
144
 
83
145
def uuid():
84
146
    """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.
89
147
    try:
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
148
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
91
149
    except IOError:
92
150
        return chomp(os.popen('uuidgen').readline())
93
151
 
94
152
 
95
 
def chomp(s):
96
 
    if s and (s[-1] == '\n'):
97
 
        return s[:-1]
98
 
    else:
99
 
        return s
100
 
 
101
 
 
102
153
def sha_file(f):
103
154
    import sha
104
 
    ## TODO: Maybe read in chunks to handle big files
105
155
    if hasattr(f, 'tell'):
106
156
        assert f.tell() == 0
107
157
    s = sha.new()
108
 
    s.update(f.read())
 
158
    BUFSIZE = 128<<10
 
159
    while True:
 
160
        b = f.read(BUFSIZE)
 
161
        if not b:
 
162
            break
 
163
        s.update(b)
109
164
    return s.hexdigest()
110
165
 
111
166
 
117
172
 
118
173
 
119
174
 
120
 
def username():
121
 
    """Return email-style username.
122
 
 
123
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
124
 
 
125
 
    :todo: Check it's reasonably well-formed.
126
 
 
127
 
    :todo: Allow taking it from a dotfile to help people on windows
128
 
           who can't easily set variables.
129
 
 
130
 
    :todo: Cope without pwd module, which is only on unix. 
131
 
    """
132
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
133
 
    if e: return e
134
 
 
 
175
def fingerprint_file(f):
 
176
    import sha
 
177
    s = sha.new()
 
178
    b = f.read()
 
179
    s.update(b)
 
180
    size = len(b)
 
181
    return {'size': size,
 
182
            'sha1': s.hexdigest()}
 
183
 
 
184
 
 
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
def _auto_user_id():
 
196
    """Calculate automatic user identification.
 
197
 
 
198
    Returns (realname, email).
 
199
 
 
200
    Only used when none is set in the environment or the id file.
 
201
 
 
202
    This previously used the FQDN as the default domain, but that can
 
203
    be very slow on machines where DNS is broken.  So now we simply
 
204
    use the hostname.
 
205
    """
135
206
    import socket
136
 
    
 
207
 
 
208
    # XXX: Any good way to get real user name on win32?
 
209
 
137
210
    try:
138
211
        import pwd
139
212
        uid = os.getuid()
140
213
        w = pwd.getpwuid(uid)
141
 
        gecos = w.pw_gecos
 
214
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
215
        username = w.pw_name.decode(bzrlib.user_encoding)
142
216
        comma = gecos.find(',')
143
217
        if comma == -1:
144
218
            realname = gecos
145
219
        else:
146
220
            realname = gecos[:comma]
147
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
221
        if not realname:
 
222
            realname = username
 
223
 
148
224
    except ImportError:
149
 
        pass
150
 
 
151
 
    import getpass, socket
152
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
153
 
 
154
 
 
 
225
        import getpass
 
226
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
227
 
 
228
    return realname, (username + '@' + socket.gethostname())
 
229
 
 
230
 
 
231
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
    v = os.environ.get('BZREMAIL')
 
237
    if v:
 
238
        return v.decode(bzrlib.user_encoding)
 
239
    
 
240
    try:
 
241
        return (open(os.path.join(config_dir(), "email"))
 
242
                .read()
 
243
                .decode(bzrlib.user_encoding)
 
244
                .rstrip("\r\n"))
 
245
    except IOError, e:
 
246
        if e.errno != errno.ENOENT:
 
247
            raise e
 
248
 
 
249
    v = os.environ.get('EMAIL')
 
250
    if v:
 
251
        return v.decode(bzrlib.user_encoding)
 
252
    else:    
 
253
        return None
 
254
 
 
255
 
 
256
def username():
 
257
    """Return email-style username.
 
258
 
 
259
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
260
 
 
261
    TODO: Check it's reasonably well-formed.
 
262
    """
 
263
    v = _get_user_id()
 
264
    if v:
 
265
        return v
 
266
    
 
267
    name, email = _auto_user_id()
 
268
    if name:
 
269
        return '%s <%s>' % (name, email)
 
270
    else:
 
271
        return email
 
272
 
 
273
 
 
274
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
155
275
def user_email():
156
276
    """Return just the email component of a username."""
157
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
277
    e = _get_user_id()
158
278
    if e:
159
 
        import re
160
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
279
        m = _EMAIL_RE.search(e)
161
280
        if not m:
162
 
            bailout('%r is not a reasonable email address' % e)
 
281
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
163
282
        return m.group(0)
164
283
 
165
 
 
166
 
    import getpass, socket
167
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
168
 
 
 
284
    return _auto_user_id()[1]
169
285
    
170
286
 
171
287
 
172
288
def compare_files(a, b):
173
289
    """Returns true if equal in contents"""
174
 
    # TODO: don't read the whole thing in one go.
175
290
    BUFSIZE = 4096
176
291
    while True:
177
292
        ai = a.read(BUFSIZE)
186
301
def local_time_offset(t=None):
187
302
    """Return offset of local zone from GMT, either at present or at time t."""
188
303
    # python2.3 localtime() can't take None
189
 
    if t is None:
 
304
    if t == None:
190
305
        t = time.time()
191
306
        
192
307
    if time.localtime(t).tm_isdst and time.daylight:
198
313
def format_date(t, offset=0, timezone='original'):
199
314
    ## TODO: Perhaps a global option to use either universal or local time?
200
315
    ## Or perhaps just let people set $TZ?
201
 
    import time
202
 
    
203
316
    assert isinstance(t, float)
204
317
    
205
318
    if timezone == 'utc':
213
326
        tt = time.localtime(t)
214
327
        offset = local_time_offset(t)
215
328
    else:
216
 
        bailout("unsupported timezone format %r",
 
329
        raise BzrError("unsupported timezone format %r",
217
330
                ['options are "utc", "original", "local"'])
218
331
 
219
332
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
232
345
 
233
346
if hasattr(os, 'urandom'): # python 2.4 and later
234
347
    rand_bytes = os.urandom
 
348
elif sys.platform == 'linux2':
 
349
    rand_bytes = file('/dev/urandom', 'rb').read
235
350
else:
236
 
    # FIXME: No good on non-Linux
237
 
    _rand_file = file('/dev/urandom', 'rb')
238
 
    rand_bytes = _rand_file.read
 
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
239
359
 
240
360
 
241
361
## TODO: We could later have path objects that remember their list
255
375
    >>> splitpath('a/../b')
256
376
    Traceback (most recent call last):
257
377
    ...
258
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
378
    BzrError: sorry, '..' not allowed in path
259
379
    """
260
380
    assert isinstance(p, types.StringTypes)
261
 
    ps = [f for f in p.split('/') if f != '.']
 
381
 
 
382
    # split on either delimiter because people might use either on
 
383
    # Windows
 
384
    ps = re.split(r'[\\/]', p)
 
385
 
 
386
    rps = []
262
387
    for f in ps:
263
388
        if f == '..':
264
 
            bailout("sorry, %r not allowed in path" % f)
265
 
    return ps
 
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
266
395
 
267
396
def joinpath(p):
268
397
    assert isinstance(p, list)
269
398
    for f in p:
270
 
        if (f == '..') or (f is None) or (f == ''):
271
 
            bailout("sorry, %r not allowed in path" % f)
272
 
    return '/'.join(p)
 
399
        if (f == '..') or (f == None) or (f == ''):
 
400
            raise BzrError("sorry, %r not allowed in path" % f)
 
401
    return os.path.join(*p)
273
402
 
274
403
 
275
404
def appendpath(p1, p2):
276
405
    if p1 == '':
277
406
        return p2
278
407
    else:
279
 
        return p1 + '/' + p2
 
408
        return os.path.join(p1, p2)
280
409
    
281
410
 
282
411
def extern_command(cmd, ignore_errors = False):
283
412
    mutter('external command: %s' % `cmd`)
284
413
    if os.system(cmd):
285
414
        if not ignore_errors:
286
 
            bailout('command failed')
287
 
 
 
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