← Back to branch summary

~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-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

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
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
19
import os, types, re, time, types
 
20
from stat import S_ISREG, S_ISDIR, 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):
62
51
        return 'file'
63
52
    elif S_ISDIR(mode):
64
53
        return 'directory'
65
 
    elif S_ISLNK(mode):
66
 
        return 'symlink'
67
 
    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
 
 
 
54
    else:
 
55
        bailout("can't handle file kind of %r" % fp)
118
56
 
119
57
 
120
58
 
135
73
        return False
136
74
 
137
75
 
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
76
def pumpfile(fromfile, tofile):
185
77
    """Copy contents of one file to another."""
186
78
    tofile.write(fromfile.read())
188
80
 
189
81
def uuid():
190
82
    """Return a new UUID"""
191
 
    try:
192
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
193
 
    except IOError:
194
 
        return chomp(os.popen('uuidgen').readline())
 
83
    
 
84
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
85
    ## Linux, but we need something portable for other systems;
 
86
    ## preferably an implementation in Python.
 
87
    bailout('uuids not allowed!')
 
88
    return chomp(os.popen('uuidgen').readline())
 
89
 
 
90
def chomp(s):
 
91
    if s and (s[-1] == '\n'):
 
92
        return s[:-1]
 
93
    else:
 
94
        return s
195
95
 
196
96
 
197
97
def sha_file(f):
198
98
    import sha
 
99
    ## TODO: Maybe read in chunks to handle big files
199
100
    if hasattr(f, 'tell'):
200
101
        assert f.tell() == 0
201
102
    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)
 
103
    s.update(f.read())
208
104
    return s.hexdigest()
209
105
 
210
106
 
216
112
 
217
113
 
218
114
 
219
 
def fingerprint_file(f):
220
 
    import sha
221
 
    s = sha.new()
222
 
    b = f.read()
223
 
    s.update(b)
224
 
    size = len(b)
225
 
    return {'size': size,
226
 
            'sha1': s.hexdigest()}
227
 
 
228
 
 
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
 
    """
 
115
def username():
 
116
    """Return email-style username.
 
117
 
 
118
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
119
 
 
120
    :todo: Check it's reasonably well-formed.
 
121
 
 
122
    :todo: Allow taking it from a dotfile to help people on windows
 
123
           who can't easily set variables.
 
124
 
 
125
    :todo: Cope without pwd module, which is only on unix. 
 
126
    """
 
127
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
128
    if e: return e
 
129
 
250
130
    import socket
251
 
 
252
 
    # XXX: Any good way to get real user name on win32?
253
 
 
 
131
    
254
132
    try:
255
133
        import pwd
256
134
        uid = os.getuid()
257
135
        w = pwd.getpwuid(uid)
258
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
 
        username = w.pw_name.decode(bzrlib.user_encoding)
260
 
        comma = gecos.find(',')
261
 
        if comma == -1:
262
 
            realname = gecos
263
 
        else:
264
 
            realname = gecos[:comma]
265
 
        if not realname:
266
 
            realname = username
267
 
 
 
136
        realname, junk = w.pw_gecos.split(',', 1)
 
137
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
268
138
    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):
 
139
        pass
 
140
 
 
141
    import getpass, socket
 
142
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
143
 
 
144
 
 
145
def user_email():
341
146
    """Return just the email component of a username."""
342
 
    e = _get_user_id(branch)
 
147
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
343
148
    if e:
 
149
        import re
344
150
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
345
151
        if not m:
346
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
152
            bailout('%r is not a reasonable email address' % e)
347
153
        return m.group(0)
348
154
 
349
 
    return _auto_user_id()[1]
 
155
 
 
156
    import getpass, socket
 
157
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
158
 
350
159
    
351
160
 
352
161
 
353
162
def compare_files(a, b):
354
163
    """Returns true if equal in contents"""
355
 
    BUFSIZE = 4096
356
 
    while True:
357
 
        ai = a.read(BUFSIZE)
358
 
        bi = b.read(BUFSIZE)
359
 
        if ai != bi:
360
 
            return False
361
 
        if ai == '':
362
 
            return True
363
 
 
364
 
 
365
 
 
366
 
def local_time_offset(t=None):
367
 
    """Return offset of local zone from GMT, either at present or at time t."""
368
 
    # python2.3 localtime() can't take None
369
 
    if t == None:
370
 
        t = time.time()
371
 
        
372
 
    if time.localtime(t).tm_isdst and time.daylight:
373
 
        return -time.altzone
374
 
    else:
375
 
        return -time.timezone
376
 
 
377
 
    
378
 
def format_date(t, offset=0, timezone='original'):
 
164
    # TODO: don't read the whole thing in one go.
 
165
    result = a.read() == b.read()
 
166
    return result
 
167
 
 
168
 
 
169
 
 
170
def format_date(t, inutc=False):
379
171
    ## TODO: Perhaps a global option to use either universal or local time?
380
172
    ## Or perhaps just let people set $TZ?
 
173
    import time
 
174
    
381
175
    assert isinstance(t, float)
382
176
    
383
 
    if timezone == 'utc':
 
177
    if inutc:
384
178
        tt = time.gmtime(t)
 
179
        zonename = 'UTC'
385
180
        offset = 0
386
 
    elif timezone == 'original':
387
 
        if offset == None:
388
 
            offset = 0
389
 
        tt = time.gmtime(t + offset)
390
 
    elif timezone == 'local':
 
181
    else:
391
182
        tt = time.localtime(t)
392
 
        offset = local_time_offset(t)
393
 
    else:
394
 
        raise BzrError("unsupported timezone format %r" % timezone,
395
 
                       ['options are "utc", "original", "local"'])
396
 
 
 
183
        if time.daylight:
 
184
            zonename = time.tzname[1]
 
185
            offset = - time.altzone
 
186
        else:
 
187
            zonename = time.tzname[0]
 
188
            offset = - time.timezone
 
189
            
397
190
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
191
            + ' ' + zonename + ' '
 
192
            + '%+03d%02d' % (offset / 3600, (offset / 60) % 60))
399
193
 
400
194
 
401
195
def compact_date(when):
410
204
 
411
205
if hasattr(os, 'urandom'): # python 2.4 and later
412
206
    rand_bytes = os.urandom
413
 
elif sys.platform == 'linux2':
414
 
    rand_bytes = file('/dev/urandom', 'rb').read
415
207
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
 
208
    # FIXME: No good on non-Linux
 
209
    _rand_file = file('/dev/urandom', 'rb')
 
210
    rand_bytes = _rand_file.read
424
211
 
425
212
 
426
213
## TODO: We could later have path objects that remember their list
440
227
    >>> splitpath('a/../b')
441
228
    Traceback (most recent call last):
442
229
    ...
443
 
    BzrError: sorry, '..' not allowed in path
 
230
    BzrError: ("sorry, '..' not allowed in path", [])
444
231
    """
445
232
    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 = []
 
233
    ps = [f for f in p.split('/') if f != '.']
452
234
    for f in ps:
453
235
        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
 
236
            bailout("sorry, %r not allowed in path" % f)
 
237
    return ps
460
238
 
461
239
def joinpath(p):
462
240
    assert isinstance(p, list)
463
241
    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)
 
242
        if (f == '..') or (f is None) or (f == ''):
 
243
            bailout("sorry, %r not allowed in path" % f)
 
244
    return '/'.join(p)
467
245
 
468
246
 
469
247
def appendpath(p1, p2):
470
248
    if p1 == '':
471
249
        return p2
472
250
    else:
473
 
        return os.path.join(p1, p2)
 
251
        return p1 + '/' + p2
474
252
    
475
253
 
476
254
def extern_command(cmd, ignore_errors = False):
477
255
    mutter('external command: %s' % `cmd`)
478
256
    if os.system(cmd):
479
257
        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
 
 
 
258
            bailout('command failed')
494
259