← 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-29 00:43:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050429004334-bbb9dc81ce0d9de3
- update install instructions

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):
37
37
    os.chmod(filename, mod)
38
38
 
39
39
 
40
 
_QUOTE_RE = None
41
 
 
42
 
 
 
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
43
41
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
 
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
57
48
 
58
49
 
59
50
def file_kind(f):
65
56
    elif S_ISLNK(mode):
66
57
        return 'symlink'
67
58
    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
 
 
 
59
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
118
60
 
119
61
 
120
62
 
135
77
        return False
136
78
 
137
79
 
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
80
def pumpfile(fromfile, tofile):
185
81
    """Copy contents of one file to another."""
186
82
    tofile.write(fromfile.read())
188
84
 
189
85
def uuid():
190
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.
191
91
    try:
192
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
92
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
193
93
    except IOError:
194
94
        return chomp(os.popen('uuidgen').readline())
195
95
 
196
96
 
 
97
def chomp(s):
 
98
    if s and (s[-1] == '\n'):
 
99
        return s[:-1]
 
100
    else:
 
101
        return s
 
102
 
 
103
 
197
104
def sha_file(f):
198
105
    import sha
 
106
    ## TODO: Maybe read in chunks to handle big files
199
107
    if hasattr(f, 'tell'):
200
108
        assert f.tell() == 0
201
109
    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)
 
110
    s.update(f.read())
208
111
    return s.hexdigest()
209
112
 
210
113
 
272
175
    return realname, (username + '@' + socket.gethostname())
273
176
 
274
177
 
275
 
def _get_user_id(branch):
 
178
def _get_user_id():
276
179
    """Return the full user id from a file or environment variable.
277
180
 
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
 
    """
 
181
    TODO: Allow taking this from a file in the branch directory too
 
182
    for per-branch ids."""
290
183
    v = os.environ.get('BZREMAIL')
291
184
    if v:
292
185
        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
186
    
306
187
    try:
307
188
        return (open(os.path.join(config_dir(), "email"))
319
200
        return None
320
201
 
321
202
 
322
 
def username(branch):
 
203
def username():
323
204
    """Return email-style username.
324
205
 
325
206
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
326
207
 
327
208
    TODO: Check it's reasonably well-formed.
328
209
    """
329
 
    v = _get_user_id(branch)
 
210
    v = _get_user_id()
330
211
    if v:
331
212
        return v
332
213
    
337
218
        return email
338
219
 
339
220
 
340
 
def user_email(branch):
 
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
222
def user_email():
341
223
    """Return just the email component of a username."""
342
 
    e = _get_user_id(branch)
 
224
    e = _get_user_id()
343
225
    if e:
344
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
226
        m = _EMAIL_RE.search(e)
345
227
        if not m:
346
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
228
            bailout("%r doesn't seem to contain a reasonable email address" % e)
347
229
        return m.group(0)
348
230
 
349
231
    return _auto_user_id()[1]
352
234
 
353
235
def compare_files(a, b):
354
236
    """Returns true if equal in contents"""
 
237
    # TODO: don't read the whole thing in one go.
355
238
    BUFSIZE = 4096
356
239
    while True:
357
240
        ai = a.read(BUFSIZE)
391
274
        tt = time.localtime(t)
392
275
        offset = local_time_offset(t)
393
276
    else:
394
 
        raise BzrError("unsupported timezone format %r" % timezone,
395
 
                       ['options are "utc", "original", "local"'])
 
277
        bailout("unsupported timezone format %r",
 
278
                ['options are "utc", "original", "local"'])
396
279
 
397
280
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
281
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
407
290
    """Return size of given open file."""
408
291
    return os.fstat(f.fileno())[ST_SIZE]
409
292
 
410
 
# Define rand_bytes based on platform.
411
 
try:
412
 
    # Python 2.4 and later have os.urandom,
413
 
    # but it doesn't work on some arches
414
 
    os.urandom(1)
 
293
 
 
294
if hasattr(os, 'urandom'): # python 2.4 and later
415
295
    rand_bytes = os.urandom
416
 
except (NotImplementedError, AttributeError):
417
 
    # If python doesn't have os.urandom, or it doesn't work,
418
 
    # then try to first pull random data from /dev/urandom
419
 
    if os.path.exists("/dev/urandom"):
420
 
        rand_bytes = file('/dev/urandom', 'rb').read
421
 
    # Otherwise, use this hack as a last resort
422
 
    else:
423
 
        # not well seeded, but better than nothing
424
 
        def rand_bytes(n):
425
 
            import random
426
 
            s = ''
427
 
            while n:
428
 
                s += chr(random.randint(0, 255))
429
 
                n -= 1
430
 
            return s
 
296
else:
 
297
    # FIXME: No good on non-Linux
 
298
    _rand_file = file('/dev/urandom', 'rb')
 
299
    rand_bytes = _rand_file.read
 
300
 
431
301
 
432
302
## TODO: We could later have path objects that remember their list
433
303
## decomposition (might be too tricksy though.)
446
316
    >>> splitpath('a/../b')
447
317
    Traceback (most recent call last):
448
318
    ...
449
 
    BzrError: sorry, '..' not allowed in path
 
319
    BzrError: ("sorry, '..' not allowed in path", [])
450
320
    """
451
321
    assert isinstance(p, types.StringTypes)
452
322
 
457
327
    rps = []
458
328
    for f in ps:
459
329
        if f == '..':
460
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
330
            bailout("sorry, %r not allowed in path" % f)
461
331
        elif (f == '.') or (f == ''):
462
332
            pass
463
333
        else:
468
338
    assert isinstance(p, list)
469
339
    for f in p:
470
340
        if (f == '..') or (f == None) or (f == ''):
471
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
341
            bailout("sorry, %r not allowed in path" % f)
472
342
    return os.path.join(*p)
473
343
 
474
344
 
483
353
    mutter('external command: %s' % `cmd`)
484
354
    if os.system(cmd):
485
355
        if not ignore_errors:
486
 
            raise BzrError('command failed')
487
 
 
488
 
 
489
 
def _read_config_value(name):
490
 
    """Read a config value from the file ~/.bzr.conf/<name>
491
 
    Return None if the file does not exist"""
492
 
    try:
493
 
        f = file(os.path.join(config_dir(), name), "r")
494
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
495
 
    except IOError, e:
496
 
        if e.errno == errno.ENOENT:
497
 
            return None
498
 
        raise
499
 
 
 
356
            bailout('command failed')
500
357