~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-09-01 11:53:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050901115302-2fcc6c750f0abe34
- make external commands work again

  code is now much simpler; no translation to objects and back again

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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 string
28
 
import sys
29
 
import time
30
 
import types
 
19
import os, types, re, time, errno, sys
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
31
21
 
32
 
import bzrlib
33
 
from bzrlib.config import config_dir, _get_user_id
34
22
from bzrlib.errors import BzrError
35
23
from bzrlib.trace import mutter
36
 
 
 
24
import bzrlib
37
25
 
38
26
def make_readonly(filename):
39
27
    """Make a filename read-only."""
 
28
    # TODO: probably needs to be fixed for windows
40
29
    mod = os.stat(filename).st_mode
41
30
    mod = mod & 0777555
42
31
    os.chmod(filename, mod)
59
48
    # TODO: I'm not really sure this is the best format either.x
60
49
    global _QUOTE_RE
61
50
    if _QUOTE_RE == None:
62
 
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
51
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
63
52
        
64
53
    if _QUOTE_RE.search(f):
65
54
        return '"' + f + '"'
75
64
        return 'directory'
76
65
    elif S_ISLNK(mode):
77
66
        return 'symlink'
78
 
    elif S_ISCHR(mode):
79
 
        return 'chardev'
80
 
    elif S_ISBLK(mode):
81
 
        return 'block'
82
 
    elif S_ISFIFO(mode):
83
 
        return 'fifo'
84
 
    elif S_ISSOCK(mode):
85
 
        return 'socket'
86
67
    else:
87
 
        return 'unknown'
 
68
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
88
69
 
89
70
 
90
71
def kind_marker(kind):
97
78
    else:
98
79
        raise BzrError('invalid file kind %r' % kind)
99
80
 
100
 
def lexists(f):
101
 
    try:
102
 
        if hasattr(os, 'lstat'):
103
 
            os.lstat(f)
104
 
        else:
105
 
            os.stat(f)
106
 
        return True
107
 
    except OSError,e:
108
 
        if e.errno == errno.ENOENT:
109
 
            return False;
110
 
        else:
111
 
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
81
 
113
 
def normalizepath(f):
114
 
    if hasattr(os.path, 'realpath'):
115
 
        F = os.path.realpath
116
 
    else:
117
 
        F = os.path.abspath
118
 
    [p,e] = os.path.split(f)
119
 
    if e == "" or e == "." or e == "..":
120
 
        return F(f)
121
 
    else:
122
 
        return os.path.join(F(p), e)
123
 
    
124
82
 
125
83
def backup_file(fn):
126
84
    """Copy a file to a backup.
129
87
 
130
88
    If the file is already a backup, it's not copied.
131
89
    """
 
90
    import os
132
91
    if fn[-1] == '~':
133
92
        return
134
93
    bfn = fn + '~'
135
94
 
136
 
    if has_symlinks() and os.path.islink(fn):
137
 
        target = os.readlink(fn)
138
 
        os.symlink(target, bfn)
139
 
        return
140
95
    inf = file(fn, 'rb')
141
96
    try:
142
97
        content = inf.read()
149
104
    finally:
150
105
        outf.close()
151
106
 
152
 
if os.name == 'nt':
153
 
    import shutil
154
 
    rename = shutil.move
155
 
else:
156
 
    rename = os.rename
 
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
 
 
118
 
157
119
 
158
120
 
159
121
def isdir(f):
164
126
        return False
165
127
 
166
128
 
 
129
 
167
130
def isfile(f):
168
131
    """True if f is a regular file."""
169
132
    try:
171
134
    except OSError:
172
135
        return False
173
136
 
174
 
def islink(f):
175
 
    """True if f is a symlink."""
176
 
    try:
177
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
178
 
    except OSError:
179
 
        return False
180
137
 
181
138
def is_inside(dir, fname):
182
139
    """True if fname is inside dir.
188
145
    The empty string as a dir name is taken as top-of-tree and matches 
189
146
    everything.
190
147
    
191
 
    >>> is_inside('src', os.path.join('src', 'foo.c'))
 
148
    >>> is_inside('src', 'src/foo.c')
192
149
    True
193
150
    >>> is_inside('src', 'srccontrol')
194
151
    False
195
 
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
 
152
    >>> is_inside('src', 'src/a/a/a/foo.c')
196
153
    True
197
154
    >>> is_inside('foo.c', 'foo.c')
198
155
    True
208
165
    
209
166
    if dir == '':
210
167
        return True
211
 
 
 
168
    
212
169
    if dir[-1] != os.sep:
213
170
        dir += os.sep
214
 
 
 
171
    
215
172
    return fname.startswith(dir)
216
173
 
217
174
 
229
186
    tofile.write(fromfile.read())
230
187
 
231
188
 
 
189
def uuid():
 
190
    """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())
 
195
 
 
196
 
232
197
def sha_file(f):
 
198
    import sha
233
199
    if hasattr(f, 'tell'):
234
200
        assert f.tell() == 0
235
201
    s = sha.new()
242
208
    return s.hexdigest()
243
209
 
244
210
 
245
 
 
246
 
def sha_strings(strings):
247
 
    """Return the sha-1 of concatenation of strings"""
248
 
    s = sha.new()
249
 
    map(s.update, strings)
250
 
    return s.hexdigest()
251
 
 
252
 
 
253
211
def sha_string(f):
 
212
    import sha
254
213
    s = sha.new()
255
214
    s.update(f)
256
215
    return s.hexdigest()
257
216
 
258
217
 
 
218
 
259
219
def fingerprint_file(f):
 
220
    import sha
260
221
    s = sha.new()
261
222
    b = f.read()
262
223
    s.update(b)
265
226
            'sha1': s.hexdigest()}
266
227
 
267
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
    """
 
250
    import socket
 
251
 
 
252
    # XXX: Any good way to get real user name on win32?
 
253
 
 
254
    try:
 
255
        import pwd
 
256
        uid = os.getuid()
 
257
        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
 
 
268
    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):
 
341
    """Return just the email component of a username."""
 
342
    e = _get_user_id(branch)
 
343
    if e:
 
344
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
345
        if not m:
 
346
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
347
        return m.group(0)
 
348
 
 
349
    return _auto_user_id()[1]
 
350
    
 
351
 
 
352
 
268
353
def compare_files(a, b):
269
354
    """Returns true if equal in contents"""
270
355
    BUFSIZE = 4096
277
362
            return True
278
363
 
279
364
 
 
365
 
280
366
def local_time_offset(t=None):
281
367
    """Return offset of local zone from GMT, either at present or at time t."""
282
368
    # python2.3 localtime() can't take None
321
407
    """Return size of given open file."""
322
408
    return os.fstat(f.fileno())[ST_SIZE]
323
409
 
324
 
# Define rand_bytes based on platform.
325
 
try:
326
 
    # Python 2.4 and later have os.urandom,
327
 
    # but it doesn't work on some arches
328
 
    os.urandom(1)
 
410
 
 
411
if hasattr(os, 'urandom'): # python 2.4 and later
329
412
    rand_bytes = os.urandom
330
 
except (NotImplementedError, AttributeError):
331
 
    # If python doesn't have os.urandom, or it doesn't work,
332
 
    # then try to first pull random data from /dev/urandom
333
 
    if os.path.exists("/dev/urandom"):
334
 
        rand_bytes = file('/dev/urandom', 'rb').read
335
 
    # Otherwise, use this hack as a last resort
336
 
    else:
337
 
        # not well seeded, but better than nothing
338
 
        def rand_bytes(n):
339
 
            import random
340
 
            s = ''
341
 
            while n:
342
 
                s += chr(random.randint(0, 255))
343
 
                n -= 1
344
 
            return s
 
413
elif sys.platform == 'linux2':
 
414
    rand_bytes = file('/dev/urandom', 'rb').read
 
415
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
 
424
 
345
425
 
346
426
## TODO: We could later have path objects that remember their list
347
427
## decomposition (might be too tricksy though.)
393
473
        return os.path.join(p1, p2)
394
474
    
395
475
 
396
 
def split_lines(s):
397
 
    """Split s into lines, but without removing the newline characters."""
398
 
    return StringIO(s).readlines()
399
 
 
400
 
 
401
 
def hardlinks_good():
402
 
    return sys.platform not in ('win32', 'cygwin', 'darwin')
403
 
 
404
 
 
405
 
def link_or_copy(src, dest):
406
 
    """Hardlink a file, or copy it if it can't be hardlinked."""
407
 
    if not hardlinks_good():
408
 
        copyfile(src, dest)
409
 
        return
 
476
def extern_command(cmd, ignore_errors = False):
 
477
    mutter('external command: %s' % `cmd`)
 
478
    if os.system(cmd):
 
479
        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"""
410
486
    try:
411
 
        os.link(src, dest)
412
 
    except (OSError, IOError), e:
413
 
        if e.errno != errno.EXDEV:
414
 
            raise
415
 
        copyfile(src, dest)
416
 
 
417
 
 
418
 
def has_symlinks():
419
 
    if hasattr(os, 'symlink'):
420
 
        return True
421
 
    else:
422
 
        return False
423
 
        
424
 
 
425
 
def contains_whitespace(s):
426
 
    """True if there are any whitespace characters in s."""
427
 
    for ch in string.whitespace:
428
 
        if ch in s:
429
 
            return True
430
 
    else:
431
 
        return False
432
 
 
433
 
 
434
 
def contains_linebreaks(s):
435
 
    """True if there is any vertical whitespace in s."""
436
 
    for ch in '\f\n\r':
437
 
        if ch in s:
438
 
            return True
439
 
    else:
440
 
        return False
 
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
 
 
494