← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2005-10-09 23:42:12 UTC
  • Revision ID: robertc@robertcollins.net-20051009234212-7973344d900afb0b
merge in niemeyers prefixed-store patch

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, sys
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
 
 
31
import bzrlib
22
32
from bzrlib.errors import BzrError
23
33
from bzrlib.trace import mutter
24
 
import bzrlib
 
34
 
25
35
 
26
36
def make_readonly(filename):
27
37
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
38
    mod = os.stat(filename).st_mode
30
39
    mod = mod & 0777555
31
40
    os.chmod(filename, mod)
37
46
    os.chmod(filename, mod)
38
47
 
39
48
 
40
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
49
_QUOTE_RE = None
41
50
 
42
 
_SLASH_RE = re.compile(r'[\\/]+')
43
51
 
44
52
def quotefn(f):
45
53
    """Return a quoted filename filename
47
55
    This previously used backslash quoting, but that works poorly on
48
56
    Windows."""
49
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
        
50
62
    if _QUOTE_RE.search(f):
51
63
        return '"' + f + '"'
52
64
    else:
61
73
        return 'directory'
62
74
    elif S_ISLNK(mode):
63
75
        return 'symlink'
 
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'
64
84
    else:
65
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
85
        return 'unknown'
66
86
 
67
87
 
68
88
def kind_marker(kind):
75
95
    else:
76
96
        raise BzrError('invalid file kind %r' % kind)
77
97
 
 
98
def lexists(f):
 
99
    try:
 
100
        if hasattr(os, 'lstat'):
 
101
            os.lstat(f)
 
102
        else:
 
103
            os.stat(f)
 
104
        return True
 
105
    except OSError,e:
 
106
        if e.errno == errno.ENOENT:
 
107
            return False;
 
108
        else:
 
109
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
78
110
 
 
111
def normalizepath(f):
 
112
    if hasattr(os.path, 'realpath'):
 
113
        F = os.path.realpath
 
114
    else:
 
115
        F = os.path.abspath
 
116
    [p,e] = os.path.split(f)
 
117
    if e == "" or e == "." or e == "..":
 
118
        return F(f)
 
119
    else:
 
120
        return os.path.join(F(p), e)
 
121
    
79
122
 
80
123
def backup_file(fn):
81
124
    """Copy a file to a backup.
84
127
 
85
128
    If the file is already a backup, it's not copied.
86
129
    """
87
 
    import os
88
130
    if fn[-1] == '~':
89
131
        return
90
132
    bfn = fn + '~'
101
143
    finally:
102
144
        outf.close()
103
145
 
104
 
def rename(path_from, path_to):
105
 
    """Basically the same as os.rename() just special for win32"""
106
 
    if sys.platform == 'win32':
107
 
        try:
108
 
            os.remove(path_to)
109
 
        except OSError, e:
110
 
            if e.errno != e.ENOENT:
111
 
                raise
112
 
    os.rename(path_from, path_to)
113
 
 
114
 
 
115
 
 
 
146
if os.name == 'nt':
 
147
    import shutil
 
148
    rename = shutil.move
 
149
else:
 
150
    rename = os.rename
116
151
 
117
152
 
118
153
def isdir(f):
123
158
        return False
124
159
 
125
160
 
126
 
 
127
161
def isfile(f):
128
162
    """True if f is a regular file."""
129
163
    try:
131
165
    except OSError:
132
166
        return False
133
167
 
 
168
def islink(f):
 
169
    """True if f is a symlink."""
 
170
    try:
 
171
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
172
    except OSError:
 
173
        return False
134
174
 
135
175
def is_inside(dir, fname):
136
176
    """True if fname is inside dir.
142
182
    The empty string as a dir name is taken as top-of-tree and matches 
143
183
    everything.
144
184
    
145
 
    >>> is_inside('src', 'src/foo.c')
 
185
    >>> is_inside('src', os.path.join('src', 'foo.c'))
146
186
    True
147
187
    >>> is_inside('src', 'srccontrol')
148
188
    False
149
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
 
189
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
150
190
    True
151
191
    >>> is_inside('foo.c', 'foo.c')
152
192
    True
162
202
    
163
203
    if dir == '':
164
204
        return True
165
 
    
 
205
 
166
206
    if dir[-1] != os.sep:
167
207
        dir += os.sep
168
 
    
 
208
 
169
209
    return fname.startswith(dir)
170
210
 
171
211
 
183
223
    tofile.write(fromfile.read())
184
224
 
185
225
 
186
 
def uuid():
187
 
    """Return a new UUID"""
188
 
    try:
189
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
190
 
    except IOError:
191
 
        return chomp(os.popen('uuidgen').readline())
192
 
 
193
 
 
194
226
def sha_file(f):
195
 
    import sha
196
227
    if hasattr(f, 'tell'):
197
228
        assert f.tell() == 0
198
229
    s = sha.new()
205
236
    return s.hexdigest()
206
237
 
207
238
 
 
239
 
 
240
def sha_strings(strings):
 
241
    """Return the sha-1 of concatenation of strings"""
 
242
    s = sha.new()
 
243
    map(s.update, strings)
 
244
    return s.hexdigest()
 
245
 
 
246
 
208
247
def sha_string(f):
209
 
    import sha
210
248
    s = sha.new()
211
249
    s.update(f)
212
250
    return s.hexdigest()
213
251
 
214
252
 
215
 
 
216
253
def fingerprint_file(f):
217
 
    import sha
218
254
    s = sha.new()
219
255
    b = f.read()
220
256
    s.update(b)
230
266
    
231
267
    TODO: Global option --config-dir to override this.
232
268
    """
233
 
    return os.path.expanduser("~/.bzr.conf")
 
269
    return os.path.join(os.path.expanduser("~"), ".bzr.conf")
234
270
 
235
271
 
236
272
def _auto_user_id():
269
305
    return realname, (username + '@' + socket.gethostname())
270
306
 
271
307
 
272
 
def _get_user_id():
 
308
def _get_user_id(branch):
273
309
    """Return the full user id from a file or environment variable.
274
310
 
275
 
    TODO: Allow taking this from a file in the branch directory too
276
 
    for per-branch ids."""
 
311
    e.g. "John Hacker <jhacker@foo.org>"
 
312
 
 
313
    branch
 
314
        A branch to use for a per-branch configuration, or None.
 
315
 
 
316
    The following are searched in order:
 
317
 
 
318
    1. $BZREMAIL
 
319
    2. .bzr/email for this branch.
 
320
    3. ~/.bzr.conf/email
 
321
    4. $EMAIL
 
322
    """
277
323
    v = os.environ.get('BZREMAIL')
278
324
    if v:
279
325
        return v.decode(bzrlib.user_encoding)
 
326
 
 
327
    if branch:
 
328
        try:
 
329
            return (branch.controlfile("email", "r") 
 
330
                    .read()
 
331
                    .decode(bzrlib.user_encoding)
 
332
                    .rstrip("\r\n"))
 
333
        except IOError, e:
 
334
            if e.errno != errno.ENOENT:
 
335
                raise
 
336
        except BzrError, e:
 
337
            pass
280
338
    
281
339
    try:
282
340
        return (open(os.path.join(config_dir(), "email"))
294
352
        return None
295
353
 
296
354
 
297
 
def username():
 
355
def username(branch):
298
356
    """Return email-style username.
299
357
 
300
358
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
301
359
 
302
360
    TODO: Check it's reasonably well-formed.
303
361
    """
304
 
    v = _get_user_id()
 
362
    v = _get_user_id(branch)
305
363
    if v:
306
364
        return v
307
365
    
312
370
        return email
313
371
 
314
372
 
315
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
316
 
def user_email():
 
373
def user_email(branch):
317
374
    """Return just the email component of a username."""
318
 
    e = _get_user_id()
 
375
    e = _get_user_id(branch)
319
376
    if e:
320
 
        m = _EMAIL_RE.search(e)
 
377
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
321
378
        if not m:
322
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
379
            raise BzrError("%r doesn't seem to contain "
 
380
                           "a reasonable email address" % e)
323
381
        return m.group(0)
324
382
 
325
383
    return _auto_user_id()[1]
326
 
    
327
384
 
328
385
 
329
386
def compare_files(a, b):
338
395
            return True
339
396
 
340
397
 
341
 
 
342
398
def local_time_offset(t=None):
343
399
    """Return offset of local zone from GMT, either at present or at time t."""
344
400
    # python2.3 localtime() can't take None
383
439
    """Return size of given open file."""
384
440
    return os.fstat(f.fileno())[ST_SIZE]
385
441
 
386
 
 
387
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
442
# Define rand_bytes based on platform.
 
443
try:
 
444
    # Python 2.4 and later have os.urandom,
 
445
    # but it doesn't work on some arches
 
446
    os.urandom(1)
388
447
    rand_bytes = os.urandom
389
 
elif sys.platform == 'linux2':
390
 
    rand_bytes = file('/dev/urandom', 'rb').read
391
 
else:
392
 
    # not well seeded, but better than nothing
393
 
    def rand_bytes(n):
394
 
        import random
395
 
        s = ''
396
 
        while n:
397
 
            s += chr(random.randint(0, 255))
398
 
            n -= 1
399
 
        return s
400
 
 
 
448
except (NotImplementedError, AttributeError):
 
449
    # If python doesn't have os.urandom, or it doesn't work,
 
450
    # then try to first pull random data from /dev/urandom
 
451
    if os.path.exists("/dev/urandom"):
 
452
        rand_bytes = file('/dev/urandom', 'rb').read
 
453
    # Otherwise, use this hack as a last resort
 
454
    else:
 
455
        # not well seeded, but better than nothing
 
456
        def rand_bytes(n):
 
457
            import random
 
458
            s = ''
 
459
            while n:
 
460
                s += chr(random.randint(0, 255))
 
461
                n -= 1
 
462
            return s
401
463
 
402
464
## TODO: We could later have path objects that remember their list
403
465
## decomposition (might be too tricksy though.)
449
511
        return os.path.join(p1, p2)
450
512
    
451
513
 
452
 
def extern_command(cmd, ignore_errors = False):
453
 
    mutter('external command: %s' % `cmd`)
454
 
    if os.system(cmd):
455
 
        if not ignore_errors:
456
 
            raise BzrError('command failed')
457
 
 
458
 
 
459
514
def _read_config_value(name):
460
515
    """Read a config value from the file ~/.bzr.conf/<name>
461
516
    Return None if the file does not exist"""
468
523
        raise
469
524
 
470
525
 
471
 
def _get_editor():
472
 
    """Return a sequence of possible editor binaries for the current platform"""
473
 
    e = _read_config_value("editor")
474
 
    if e is not None:
475
 
        yield e
476
 
        
477
 
    if os.name == "windows":
478
 
        yield "notepad.exe"
479
 
    elif os.name == "posix":
480
 
        try:
481
 
            yield os.environ["EDITOR"]
482
 
        except KeyError:
483
 
            yield "/usr/bin/vi"
484
 
 
485
 
 
486
 
def _run_editor(filename):
487
 
    """Try to execute an editor to edit the commit message. Returns True on success,
488
 
    False on failure"""
489
 
    for e in _get_editor():
490
 
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
491
 
        if x == 0:
492
 
            return True
493
 
        elif x == 127:
494
 
            continue
495
 
        else:
496
 
            break
497
 
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
498
 
    return False
499
 
                          
500
 
 
501
 
def get_text_message(infotext, ignoreline = "default"):
502
 
    import tempfile
503
 
    
504
 
    if ignoreline == "default":
505
 
        ignoreline = "-- This line and the following will be ignored --"
506
 
        
 
526
def split_lines(s):
 
527
    """Split s into lines, but without removing the newline characters."""
 
528
    return StringIO(s).readlines()
 
529
 
 
530
 
 
531
def hardlinks_good():
 
532
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
533
 
 
534
 
 
535
def link_or_copy(src, dest):
 
536
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
537
    if not hardlinks_good():
 
538
        copyfile(src, dest)
 
539
        return
507
540
    try:
508
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
509
 
        msgfile = os.close(tmp_fileno)
510
 
        if infotext is not None and infotext != "":
511
 
            hasinfo = True
512
 
            msgfile = file(msgfilename, "w")
513
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
514
 
            msgfile.close()
515
 
        else:
516
 
            hasinfo = False
517
 
 
518
 
        if not _run_editor(msgfilename):
519
 
            return None
520
 
        
521
 
        started = False
522
 
        msg = []
523
 
        lastline, nlines = 0, 0
524
 
        for line in file(msgfilename, "r"):
525
 
            stripped_line = line.strip()
526
 
            # strip empty line before the log message starts
527
 
            if not started:
528
 
                if stripped_line != "":
529
 
                    started = True
530
 
                else:
531
 
                    continue
532
 
            # check for the ignore line only if there
533
 
            # is additional information at the end
534
 
            if hasinfo and stripped_line == ignoreline:
535
 
                break
536
 
            nlines += 1
537
 
            # keep track of the last line that had some content
538
 
            if stripped_line != "":
539
 
                lastline = nlines
540
 
            msg.append(line)
541
 
            
542
 
        if len(msg) == 0:
543
 
            return None
544
 
        # delete empty lines at the end
545
 
        del msg[lastline:]
546
 
        # add a newline at the end, if needed
547
 
        if not msg[-1].endswith("\n"):
548
 
            return "%s%s" % ("".join(msg), "\n")
549
 
        else:
550
 
            return "".join(msg)
551
 
    finally:
552
 
        # delete the msg file in any case
553
 
        try: os.unlink(msgfilename)
554
 
        except IOError: pass
 
541
        os.link(src, dest)
 
542
    except (OSError, IOError), e:
 
543
        if e.errno != errno.EXDEV:
 
544
            raise
 
545
        copyfile(src, dest)
 
546
 
 
547
 
 
548
def has_symlinks():
 
549
    if hasattr(os, 'symlink'):
 
550
        return True
 
551
    else:
 
552
        return False