← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

- stub for revision properties

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, errno
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
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
21
30
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
24
31
import bzrlib
 
32
from bzrlib.config import config_dir, _get_user_id
 
33
from bzrlib.errors import BzrError
 
34
from bzrlib.trace import mutter
 
35
 
25
36
 
26
37
def make_readonly(filename):
27
38
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
39
    mod = os.stat(filename).st_mode
30
40
    mod = mod & 0777555
31
41
    os.chmod(filename, mod)
37
47
    os.chmod(filename, mod)
38
48
 
39
49
 
40
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
50
_QUOTE_RE = None
 
51
 
 
52
 
41
53
def quotefn(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
 
54
    """Return a quoted filename filename
 
55
 
 
56
    This previously used backslash quoting, but that works poorly on
 
57
    Windows."""
 
58
    # TODO: I'm not really sure this is the best format either.x
 
59
    global _QUOTE_RE
 
60
    if _QUOTE_RE == None:
 
61
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
62
        
 
63
    if _QUOTE_RE.search(f):
 
64
        return '"' + f + '"'
 
65
    else:
 
66
        return f
48
67
 
49
68
 
50
69
def file_kind(f):
55
74
        return 'directory'
56
75
    elif S_ISLNK(mode):
57
76
        return 'symlink'
58
 
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
60
 
 
 
77
    elif S_ISCHR(mode):
 
78
        return 'chardev'
 
79
    elif S_ISBLK(mode):
 
80
        return 'block'
 
81
    elif S_ISFIFO(mode):
 
82
        return 'fifo'
 
83
    elif S_ISSOCK(mode):
 
84
        return 'socket'
 
85
    else:
 
86
        return 'unknown'
 
87
 
 
88
 
 
89
def kind_marker(kind):
 
90
    if kind == 'file':
 
91
        return ''
 
92
    elif kind == 'directory':
 
93
        return '/'
 
94
    elif kind == 'symlink':
 
95
        return '@'
 
96
    else:
 
97
        raise BzrError('invalid file kind %r' % kind)
 
98
 
 
99
def lexists(f):
 
100
    try:
 
101
        if hasattr(os, 'lstat'):
 
102
            os.lstat(f)
 
103
        else:
 
104
            os.stat(f)
 
105
        return True
 
106
    except OSError,e:
 
107
        if e.errno == errno.ENOENT:
 
108
            return False;
 
109
        else:
 
110
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
111
 
 
112
def normalizepath(f):
 
113
    if hasattr(os.path, 'realpath'):
 
114
        F = os.path.realpath
 
115
    else:
 
116
        F = os.path.abspath
 
117
    [p,e] = os.path.split(f)
 
118
    if e == "" or e == "." or e == "..":
 
119
        return F(f)
 
120
    else:
 
121
        return os.path.join(F(p), e)
 
122
    
 
123
 
 
124
def backup_file(fn):
 
125
    """Copy a file to a backup.
 
126
 
 
127
    Backups are named in GNU-style, with a ~ suffix.
 
128
 
 
129
    If the file is already a backup, it's not copied.
 
130
    """
 
131
    if fn[-1] == '~':
 
132
        return
 
133
    bfn = fn + '~'
 
134
 
 
135
    if has_symlinks() and os.path.islink(fn):
 
136
        target = os.readlink(fn)
 
137
        os.symlink(target, bfn)
 
138
        return
 
139
    inf = file(fn, 'rb')
 
140
    try:
 
141
        content = inf.read()
 
142
    finally:
 
143
        inf.close()
 
144
    
 
145
    outf = file(bfn, 'wb')
 
146
    try:
 
147
        outf.write(content)
 
148
    finally:
 
149
        outf.close()
 
150
 
 
151
if os.name == 'nt':
 
152
    import shutil
 
153
    rename = shutil.move
 
154
else:
 
155
    rename = os.rename
61
156
 
62
157
 
63
158
def isdir(f):
68
163
        return False
69
164
 
70
165
 
71
 
 
72
166
def isfile(f):
73
167
    """True if f is a regular file."""
74
168
    try:
76
170
    except OSError:
77
171
        return False
78
172
 
 
173
def islink(f):
 
174
    """True if f is a symlink."""
 
175
    try:
 
176
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
177
    except OSError:
 
178
        return False
 
179
 
 
180
def is_inside(dir, fname):
 
181
    """True if fname is inside dir.
 
182
    
 
183
    The parameters should typically be passed to os.path.normpath first, so
 
184
    that . and .. and repeated slashes are eliminated, and the separators
 
185
    are canonical for the platform.
 
186
    
 
187
    The empty string as a dir name is taken as top-of-tree and matches 
 
188
    everything.
 
189
    
 
190
    >>> is_inside('src', os.path.join('src', 'foo.c'))
 
191
    True
 
192
    >>> is_inside('src', 'srccontrol')
 
193
    False
 
194
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
 
195
    True
 
196
    >>> is_inside('foo.c', 'foo.c')
 
197
    True
 
198
    >>> is_inside('foo.c', '')
 
199
    False
 
200
    >>> is_inside('', 'foo.c')
 
201
    True
 
202
    """
 
203
    # XXX: Most callers of this can actually do something smarter by 
 
204
    # looking at the inventory
 
205
    if dir == fname:
 
206
        return True
 
207
    
 
208
    if dir == '':
 
209
        return True
 
210
 
 
211
    if dir[-1] != os.sep:
 
212
        dir += os.sep
 
213
 
 
214
    return fname.startswith(dir)
 
215
 
 
216
 
 
217
def is_inside_any(dir_list, fname):
 
218
    """True if fname is inside any of given dirs."""
 
219
    for dirname in dir_list:
 
220
        if is_inside(dirname, fname):
 
221
            return True
 
222
    else:
 
223
        return False
 
224
 
79
225
 
80
226
def pumpfile(fromfile, tofile):
81
227
    """Copy contents of one file to another."""
82
228
    tofile.write(fromfile.read())
83
229
 
84
230
 
85
 
def uuid():
86
 
    """Return a new UUID"""
87
 
    try:
88
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
89
 
    except IOError:
90
 
        return chomp(os.popen('uuidgen').readline())
91
 
 
92
 
 
93
231
def sha_file(f):
94
 
    import sha
95
232
    if hasattr(f, 'tell'):
96
233
        assert f.tell() == 0
97
234
    s = sha.new()
104
241
    return s.hexdigest()
105
242
 
106
243
 
 
244
 
 
245
def sha_strings(strings):
 
246
    """Return the sha-1 of concatenation of strings"""
 
247
    s = sha.new()
 
248
    map(s.update, strings)
 
249
    return s.hexdigest()
 
250
 
 
251
 
107
252
def sha_string(f):
108
 
    import sha
109
253
    s = sha.new()
110
254
    s.update(f)
111
255
    return s.hexdigest()
112
256
 
113
257
 
114
 
 
115
258
def fingerprint_file(f):
116
 
    import sha
117
259
    s = sha.new()
118
260
    b = f.read()
119
261
    s.update(b)
122
264
            'sha1': s.hexdigest()}
123
265
 
124
266
 
125
 
def config_dir():
126
 
    """Return per-user configuration directory.
127
 
 
128
 
    By default this is ~/.bzr.conf/
129
 
    
130
 
    TODO: Global option --config-dir to override this.
131
 
    """
132
 
    return os.path.expanduser("~/.bzr.conf")
133
 
 
134
 
 
135
 
def _auto_user_id():
136
 
    """Calculate automatic user identification.
137
 
 
138
 
    Returns (realname, email).
139
 
 
140
 
    Only used when none is set in the environment or the id file.
141
 
 
142
 
    This previously used the FQDN as the default domain, but that can
143
 
    be very slow on machines where DNS is broken.  So now we simply
144
 
    use the hostname.
145
 
    """
146
 
    import socket
147
 
 
148
 
    # XXX: Any good way to get real user name on win32?
149
 
 
150
 
    try:
151
 
        import pwd
152
 
        uid = os.getuid()
153
 
        w = pwd.getpwuid(uid)
154
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
 
        username = w.pw_name.decode(bzrlib.user_encoding)
156
 
        comma = gecos.find(',')
157
 
        if comma == -1:
158
 
            realname = gecos
159
 
        else:
160
 
            realname = gecos[:comma]
161
 
        if not realname:
162
 
            realname = username
163
 
 
164
 
    except ImportError:
165
 
        import getpass
166
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
167
 
 
168
 
    return realname, (username + '@' + socket.gethostname())
169
 
 
170
 
 
171
 
def _get_user_id():
172
 
    """Return the full user id from a file or environment variable.
173
 
 
174
 
    TODO: Allow taking this from a file in the branch directory too
175
 
    for per-branch ids."""
176
 
    v = os.environ.get('BZREMAIL')
177
 
    if v:
178
 
        return v.decode(bzrlib.user_encoding)
179
 
    
180
 
    try:
181
 
        return (open(os.path.join(config_dir(), "email"))
182
 
                .read()
183
 
                .decode(bzrlib.user_encoding)
184
 
                .rstrip("\r\n"))
185
 
    except IOError, e:
186
 
        if e.errno != errno.ENOENT:
187
 
            raise e
188
 
 
189
 
    v = os.environ.get('EMAIL')
190
 
    if v:
191
 
        return v.decode(bzrlib.user_encoding)
192
 
    else:    
193
 
        return None
194
 
 
195
 
 
196
 
def username():
197
 
    """Return email-style username.
198
 
 
199
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
200
 
 
201
 
    TODO: Check it's reasonably well-formed.
202
 
    """
203
 
    v = _get_user_id()
204
 
    if v:
205
 
        return v
206
 
    
207
 
    name, email = _auto_user_id()
208
 
    if name:
209
 
        return '%s <%s>' % (name, email)
210
 
    else:
211
 
        return email
212
 
 
213
 
 
214
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
215
 
def user_email():
216
 
    """Return just the email component of a username."""
217
 
    e = _get_user_id()
218
 
    if e:
219
 
        m = _EMAIL_RE.search(e)
220
 
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
222
 
        return m.group(0)
223
 
 
224
 
    return _auto_user_id()[1]
225
 
    
226
 
 
227
 
 
228
267
def compare_files(a, b):
229
268
    """Returns true if equal in contents"""
230
269
    BUFSIZE = 4096
237
276
            return True
238
277
 
239
278
 
240
 
 
241
279
def local_time_offset(t=None):
242
280
    """Return offset of local zone from GMT, either at present or at time t."""
243
281
    # python2.3 localtime() can't take None
266
304
        tt = time.localtime(t)
267
305
        offset = local_time_offset(t)
268
306
    else:
269
 
        bailout("unsupported timezone format %r",
270
 
                ['options are "utc", "original", "local"'])
 
307
        raise BzrError("unsupported timezone format %r" % timezone,
 
308
                       ['options are "utc", "original", "local"'])
271
309
 
272
310
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
311
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
282
320
    """Return size of given open file."""
283
321
    return os.fstat(f.fileno())[ST_SIZE]
284
322
 
285
 
 
286
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
323
# Define rand_bytes based on platform.
 
324
try:
 
325
    # Python 2.4 and later have os.urandom,
 
326
    # but it doesn't work on some arches
 
327
    os.urandom(1)
287
328
    rand_bytes = os.urandom
288
 
else:
289
 
    # FIXME: No good on non-Linux
290
 
    _rand_file = file('/dev/urandom', 'rb')
291
 
    rand_bytes = _rand_file.read
292
 
 
 
329
except (NotImplementedError, AttributeError):
 
330
    # If python doesn't have os.urandom, or it doesn't work,
 
331
    # then try to first pull random data from /dev/urandom
 
332
    if os.path.exists("/dev/urandom"):
 
333
        rand_bytes = file('/dev/urandom', 'rb').read
 
334
    # Otherwise, use this hack as a last resort
 
335
    else:
 
336
        # not well seeded, but better than nothing
 
337
        def rand_bytes(n):
 
338
            import random
 
339
            s = ''
 
340
            while n:
 
341
                s += chr(random.randint(0, 255))
 
342
                n -= 1
 
343
            return s
293
344
 
294
345
## TODO: We could later have path objects that remember their list
295
346
## decomposition (might be too tricksy though.)
308
359
    >>> splitpath('a/../b')
309
360
    Traceback (most recent call last):
310
361
    ...
311
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
362
    BzrError: sorry, '..' not allowed in path
312
363
    """
313
364
    assert isinstance(p, types.StringTypes)
314
365
 
319
370
    rps = []
320
371
    for f in ps:
321
372
        if f == '..':
322
 
            bailout("sorry, %r not allowed in path" % f)
 
373
            raise BzrError("sorry, %r not allowed in path" % f)
323
374
        elif (f == '.') or (f == ''):
324
375
            pass
325
376
        else:
330
381
    assert isinstance(p, list)
331
382
    for f in p:
332
383
        if (f == '..') or (f == None) or (f == ''):
333
 
            bailout("sorry, %r not allowed in path" % f)
 
384
            raise BzrError("sorry, %r not allowed in path" % f)
334
385
    return os.path.join(*p)
335
386
 
336
387
 
341
392
        return os.path.join(p1, p2)
342
393
    
343
394
 
344
 
def extern_command(cmd, ignore_errors = False):
345
 
    mutter('external command: %s' % `cmd`)
346
 
    if os.system(cmd):
347
 
        if not ignore_errors:
348
 
            bailout('command failed')
349
 
 
 
395
def split_lines(s):
 
396
    """Split s into lines, but without removing the newline characters."""
 
397
    return StringIO(s).readlines()
 
398
 
 
399
 
 
400
def hardlinks_good():
 
401
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
402
 
 
403
 
 
404
def link_or_copy(src, dest):
 
405
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
406
    if not hardlinks_good():
 
407
        copyfile(src, dest)
 
408
        return
 
409
    try:
 
410
        os.link(src, dest)
 
411
    except (OSError, IOError), e:
 
412
        if e.errno != errno.EXDEV:
 
413
            raise
 
414
        copyfile(src, dest)
 
415
 
 
416
 
 
417
def has_symlinks():
 
418
    if hasattr(os, 'symlink'):
 
419
        return True
 
420
    else:
 
421
        return False