← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-29 21:13:03 UTC
  • mto: (1393.1.12)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050929211303-7f1f9bf969d65dc3
All tests pass.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
1
# Bazaar-NG -- distributed version control
2
 
 
 
2
#
3
3
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
4
#
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
9
 
 
 
9
#
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
13
# GNU General Public License for more details.
14
 
 
 
14
#
15
15
# You should have received a copy of the GNU General Public License
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
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from errors import bailout
 
19
from shutil import copyfile
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
22
from cStringIO import StringIO
 
23
import errno
 
24
import os
 
25
import re
 
26
import sha
 
27
import sys
 
28
import time
 
29
import types
 
30
 
 
31
import bzrlib
 
32
from bzrlib.errors import BzrError
 
33
from bzrlib.trace import mutter
 
34
 
23
35
 
24
36
def make_readonly(filename):
25
37
    """Make a filename read-only."""
26
 
    # TODO: probably needs to be fixed for windows
27
38
    mod = os.stat(filename).st_mode
28
39
    mod = mod & 0777555
29
40
    os.chmod(filename, mod)
35
46
    os.chmod(filename, mod)
36
47
 
37
48
 
38
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
49
_QUOTE_RE = None
 
50
 
 
51
 
39
52
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
 
53
    """Return a quoted filename filename
 
54
 
 
55
    This previously used backslash quoting, but that works poorly on
 
56
    Windows."""
 
57
    # TODO: I'm not really sure this is the best format either.x
 
58
    global _QUOTE_RE
 
59
    if _QUOTE_RE == None:
 
60
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
61
        
 
62
    if _QUOTE_RE.search(f):
 
63
        return '"' + f + '"'
 
64
    else:
 
65
        return f
46
66
 
47
67
 
48
68
def file_kind(f):
53
73
        return 'directory'
54
74
    elif S_ISLNK(mode):
55
75
        return 'symlink'
56
 
    else:
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
58
 
 
 
76
    elif S_ISCHR(mode):
 
77
        return 'chardev'
 
78
    elif S_ISBLK(mode):
 
79
        return 'block'
 
80
    elif S_ISFIFO(mode):
 
81
        return 'fifo'
 
82
    elif S_ISSOCK(mode):
 
83
        return 'socket'
 
84
    else:
 
85
        return 'unknown'
 
86
 
 
87
 
 
88
def kind_marker(kind):
 
89
    if kind == 'file':
 
90
        return ''
 
91
    elif kind == 'directory':
 
92
        return '/'
 
93
    elif kind == 'symlink':
 
94
        return '@'
 
95
    else:
 
96
        raise BzrError('invalid file kind %r' % kind)
 
97
 
 
98
 
 
99
def backup_file(fn):
 
100
    """Copy a file to a backup.
 
101
 
 
102
    Backups are named in GNU-style, with a ~ suffix.
 
103
 
 
104
    If the file is already a backup, it's not copied.
 
105
    """
 
106
    if fn[-1] == '~':
 
107
        return
 
108
    bfn = fn + '~'
 
109
 
 
110
    inf = file(fn, 'rb')
 
111
    try:
 
112
        content = inf.read()
 
113
    finally:
 
114
        inf.close()
 
115
    
 
116
    outf = file(bfn, 'wb')
 
117
    try:
 
118
        outf.write(content)
 
119
    finally:
 
120
        outf.close()
 
121
 
 
122
if os.name == 'nt':
 
123
    import shutil
 
124
    rename = shutil.move
 
125
else:
 
126
    rename = os.rename
59
127
 
60
128
 
61
129
def isdir(f):
66
134
        return False
67
135
 
68
136
 
69
 
 
70
137
def isfile(f):
71
138
    """True if f is a regular file."""
72
139
    try:
75
142
        return False
76
143
 
77
144
 
 
145
def is_inside(dir, fname):
 
146
    """True if fname is inside dir.
 
147
    
 
148
    The parameters should typically be passed to os.path.normpath first, so
 
149
    that . and .. and repeated slashes are eliminated, and the separators
 
150
    are canonical for the platform.
 
151
    
 
152
    The empty string as a dir name is taken as top-of-tree and matches 
 
153
    everything.
 
154
    
 
155
    >>> is_inside('src', os.path.join('src', 'foo.c'))
 
156
    True
 
157
    >>> is_inside('src', 'srccontrol')
 
158
    False
 
159
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
 
160
    True
 
161
    >>> is_inside('foo.c', 'foo.c')
 
162
    True
 
163
    >>> is_inside('foo.c', '')
 
164
    False
 
165
    >>> is_inside('', 'foo.c')
 
166
    True
 
167
    """
 
168
    # XXX: Most callers of this can actually do something smarter by 
 
169
    # looking at the inventory
 
170
    if dir == fname:
 
171
        return True
 
172
    
 
173
    if dir == '':
 
174
        return True
 
175
 
 
176
    if dir[-1] != os.sep:
 
177
        dir += os.sep
 
178
 
 
179
    return fname.startswith(dir)
 
180
 
 
181
 
 
182
def is_inside_any(dir_list, fname):
 
183
    """True if fname is inside any of given dirs."""
 
184
    for dirname in dir_list:
 
185
        if is_inside(dirname, fname):
 
186
            return True
 
187
    else:
 
188
        return False
 
189
 
 
190
 
78
191
def pumpfile(fromfile, tofile):
79
192
    """Copy contents of one file to another."""
80
193
    tofile.write(fromfile.read())
81
194
 
82
195
 
83
 
def uuid():
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.
89
 
    try:
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
91
 
    except IOError:
92
 
        return chomp(os.popen('uuidgen').readline())
93
 
 
94
 
 
95
 
def chomp(s):
96
 
    if s and (s[-1] == '\n'):
97
 
        return s[:-1]
98
 
    else:
99
 
        return s
100
 
 
101
 
 
102
196
def sha_file(f):
103
 
    import sha
104
 
    ## TODO: Maybe read in chunks to handle big files
105
197
    if hasattr(f, 'tell'):
106
198
        assert f.tell() == 0
107
199
    s = sha.new()
108
 
    s.update(f.read())
 
200
    BUFSIZE = 128<<10
 
201
    while True:
 
202
        b = f.read(BUFSIZE)
 
203
        if not b:
 
204
            break
 
205
        s.update(b)
 
206
    return s.hexdigest()
 
207
 
 
208
 
 
209
 
 
210
def sha_strings(strings):
 
211
    """Return the sha-1 of concatenation of strings"""
 
212
    s = sha.new()
 
213
    map(s.update, strings)
109
214
    return s.hexdigest()
110
215
 
111
216
 
112
217
def sha_string(f):
113
 
    import sha
114
218
    s = sha.new()
115
219
    s.update(f)
116
220
    return s.hexdigest()
117
221
 
118
222
 
119
 
 
120
223
def fingerprint_file(f):
121
 
    import sha
122
224
    s = sha.new()
123
225
    b = f.read()
124
226
    s.update(b)
127
229
            'sha1': s.hexdigest()}
128
230
 
129
231
 
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
 
 
 
232
def config_dir():
 
233
    """Return per-user configuration directory.
 
234
 
 
235
    By default this is ~/.bzr.conf/
 
236
    
 
237
    TODO: Global option --config-dir to override this.
 
238
    """
 
239
    return os.path.join(os.path.expanduser("~"), ".bzr.conf")
 
240
 
 
241
 
 
242
def _auto_user_id():
 
243
    """Calculate automatic user identification.
 
244
 
 
245
    Returns (realname, email).
 
246
 
 
247
    Only used when none is set in the environment or the id file.
 
248
 
 
249
    This previously used the FQDN as the default domain, but that can
 
250
    be very slow on machines where DNS is broken.  So now we simply
 
251
    use the hostname.
 
252
    """
146
253
    import socket
147
 
    
 
254
 
 
255
    # XXX: Any good way to get real user name on win32?
 
256
 
148
257
    try:
149
258
        import pwd
150
259
        uid = os.getuid()
151
260
        w = pwd.getpwuid(uid)
152
 
        gecos = w.pw_gecos
 
261
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
262
        username = w.pw_name.decode(bzrlib.user_encoding)
153
263
        comma = gecos.find(',')
154
264
        if comma == -1:
155
265
            realname = gecos
156
266
        else:
157
267
            realname = gecos[:comma]
158
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
268
        if not realname:
 
269
            realname = username
 
270
 
159
271
    except ImportError:
160
 
        pass
161
 
 
162
 
    import getpass, socket
163
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
164
 
 
165
 
 
166
 
def user_email():
 
272
        import getpass
 
273
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
274
 
 
275
    return realname, (username + '@' + socket.gethostname())
 
276
 
 
277
 
 
278
def _get_user_id(branch):
 
279
    """Return the full user id from a file or environment variable.
 
280
 
 
281
    e.g. "John Hacker <jhacker@foo.org>"
 
282
 
 
283
    branch
 
284
        A branch to use for a per-branch configuration, or None.
 
285
 
 
286
    The following are searched in order:
 
287
 
 
288
    1. $BZREMAIL
 
289
    2. .bzr/email for this branch.
 
290
    3. ~/.bzr.conf/email
 
291
    4. $EMAIL
 
292
    """
 
293
    v = os.environ.get('BZREMAIL')
 
294
    if v:
 
295
        return v.decode(bzrlib.user_encoding)
 
296
 
 
297
    if branch:
 
298
        try:
 
299
            return (branch.controlfile("email", "r") 
 
300
                    .read()
 
301
                    .decode(bzrlib.user_encoding)
 
302
                    .rstrip("\r\n"))
 
303
        except IOError, e:
 
304
            if e.errno != errno.ENOENT:
 
305
                raise
 
306
        except BzrError, e:
 
307
            pass
 
308
    
 
309
    try:
 
310
        return (open(os.path.join(config_dir(), "email"))
 
311
                .read()
 
312
                .decode(bzrlib.user_encoding)
 
313
                .rstrip("\r\n"))
 
314
    except IOError, e:
 
315
        if e.errno != errno.ENOENT:
 
316
            raise e
 
317
 
 
318
    v = os.environ.get('EMAIL')
 
319
    if v:
 
320
        return v.decode(bzrlib.user_encoding)
 
321
    else:    
 
322
        return None
 
323
 
 
324
 
 
325
def username(branch):
 
326
    """Return email-style username.
 
327
 
 
328
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
329
 
 
330
    TODO: Check it's reasonably well-formed.
 
331
    """
 
332
    v = _get_user_id(branch)
 
333
    if v:
 
334
        return v
 
335
    
 
336
    name, email = _auto_user_id()
 
337
    if name:
 
338
        return '%s <%s>' % (name, email)
 
339
    else:
 
340
        return email
 
341
 
 
342
 
 
343
def user_email(branch):
167
344
    """Return just the email component of a username."""
168
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
345
    e = _get_user_id(branch)
169
346
    if e:
170
 
        import re
171
347
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
172
348
        if not m:
173
 
            bailout('%r is not a reasonable email address' % e)
 
349
            raise BzrError("%r doesn't seem to contain "
 
350
                           "a reasonable email address" % e)
174
351
        return m.group(0)
175
352
 
176
 
 
177
 
    import getpass, socket
178
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
179
 
 
180
 
    
 
353
    return _auto_user_id()[1]
181
354
 
182
355
 
183
356
def compare_files(a, b):
184
357
    """Returns true if equal in contents"""
185
 
    # TODO: don't read the whole thing in one go.
186
358
    BUFSIZE = 4096
187
359
    while True:
188
360
        ai = a.read(BUFSIZE)
193
365
            return True
194
366
 
195
367
 
196
 
 
197
368
def local_time_offset(t=None):
198
369
    """Return offset of local zone from GMT, either at present or at time t."""
199
370
    # python2.3 localtime() can't take None
200
 
    if t is None:
 
371
    if t == None:
201
372
        t = time.time()
202
373
        
203
374
    if time.localtime(t).tm_isdst and time.daylight:
209
380
def format_date(t, offset=0, timezone='original'):
210
381
    ## TODO: Perhaps a global option to use either universal or local time?
211
382
    ## Or perhaps just let people set $TZ?
212
 
    import time
213
 
    
214
383
    assert isinstance(t, float)
215
384
    
216
385
    if timezone == 'utc':
224
393
        tt = time.localtime(t)
225
394
        offset = local_time_offset(t)
226
395
    else:
227
 
        bailout("unsupported timezone format %r",
228
 
                ['options are "utc", "original", "local"'])
 
396
        raise BzrError("unsupported timezone format %r" % timezone,
 
397
                       ['options are "utc", "original", "local"'])
229
398
 
230
399
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
231
400
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
240
409
    """Return size of given open file."""
241
410
    return os.fstat(f.fileno())[ST_SIZE]
242
411
 
243
 
 
244
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
412
# Define rand_bytes based on platform.
 
413
try:
 
414
    # Python 2.4 and later have os.urandom,
 
415
    # but it doesn't work on some arches
 
416
    os.urandom(1)
245
417
    rand_bytes = os.urandom
246
 
else:
247
 
    # FIXME: No good on non-Linux
248
 
    _rand_file = file('/dev/urandom', 'rb')
249
 
    rand_bytes = _rand_file.read
250
 
 
 
418
except (NotImplementedError, AttributeError):
 
419
    # If python doesn't have os.urandom, or it doesn't work,
 
420
    # then try to first pull random data from /dev/urandom
 
421
    if os.path.exists("/dev/urandom"):
 
422
        rand_bytes = file('/dev/urandom', 'rb').read
 
423
    # Otherwise, use this hack as a last resort
 
424
    else:
 
425
        # not well seeded, but better than nothing
 
426
        def rand_bytes(n):
 
427
            import random
 
428
            s = ''
 
429
            while n:
 
430
                s += chr(random.randint(0, 255))
 
431
                n -= 1
 
432
            return s
251
433
 
252
434
## TODO: We could later have path objects that remember their list
253
435
## decomposition (might be too tricksy though.)
266
448
    >>> splitpath('a/../b')
267
449
    Traceback (most recent call last):
268
450
    ...
269
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
451
    BzrError: sorry, '..' not allowed in path
270
452
    """
271
453
    assert isinstance(p, types.StringTypes)
272
 
    ps = [f for f in p.split('/') if f != '.']
 
454
 
 
455
    # split on either delimiter because people might use either on
 
456
    # Windows
 
457
    ps = re.split(r'[\\/]', p)
 
458
 
 
459
    rps = []
273
460
    for f in ps:
274
461
        if f == '..':
275
 
            bailout("sorry, %r not allowed in path" % f)
276
 
    return ps
 
462
            raise BzrError("sorry, %r not allowed in path" % f)
 
463
        elif (f == '.') or (f == ''):
 
464
            pass
 
465
        else:
 
466
            rps.append(f)
 
467
    return rps
277
468
 
278
469
def joinpath(p):
279
470
    assert isinstance(p, list)
280
471
    for f in p:
281
 
        if (f == '..') or (f is None) or (f == ''):
282
 
            bailout("sorry, %r not allowed in path" % f)
283
 
    return '/'.join(p)
 
472
        if (f == '..') or (f == None) or (f == ''):
 
473
            raise BzrError("sorry, %r not allowed in path" % f)
 
474
    return os.path.join(*p)
284
475
 
285
476
 
286
477
def appendpath(p1, p2):
287
478
    if p1 == '':
288
479
        return p2
289
480
    else:
290
 
        return p1 + '/' + p2
 
481
        return os.path.join(p1, p2)
291
482
    
292
483
 
293
 
def extern_command(cmd, ignore_errors = False):
294
 
    mutter('external command: %s' % `cmd`)
295
 
    if os.system(cmd):
296
 
        if not ignore_errors:
297
 
            bailout('command failed')
298
 
 
 
484
def _read_config_value(name):
 
485
    """Read a config value from the file ~/.bzr.conf/<name>
 
486
    Return None if the file does not exist"""
 
487
    try:
 
488
        f = file(os.path.join(config_dir(), name), "r")
 
489
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
 
490
    except IOError, e:
 
491
        if e.errno == errno.ENOENT:
 
492
            return None
 
493
        raise
 
494
 
 
495
 
 
496
def split_lines(s):
 
497
    """Split s into lines, but without removing the newline characters."""
 
498
    return StringIO(s).readlines()
 
499
 
 
500
 
 
501
def hardlinks_good():
 
502
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
503
 
 
504
 
 
505
def link_or_copy(src, dest):
 
506
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
507
    if not hardlinks_good():
 
508
        copyfile(src, dest)
 
509
        return
 
510
    try:
 
511
        os.link(src, dest)
 
512
    except (OSError, IOError), e:
 
513
        if e.errno != errno.EXDEV:
 
514
            raise
 
515
        copyfile(src, dest)