/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2005-10-14 01:56:08 UTC
  • mto: This revision was merged to the branch mainline in revision 1453.
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051014015608-2970671a76324ad8
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs

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
 
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 + '~'
91
133
 
 
134
    if has_symlinks() and os.path.islink(fn):
 
135
        target = os.readlink(fn)
 
136
        os.symlink(target, bfn)
 
137
        return
92
138
    inf = file(fn, 'rb')
93
139
    try:
94
140
        content = inf.read()
101
147
    finally:
102
148
        outf.close()
103
149
 
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
 
 
 
150
if os.name == 'nt':
 
151
    import shutil
 
152
    rename = shutil.move
 
153
else:
 
154
    rename = os.rename
116
155
 
117
156
 
118
157
def isdir(f):
123
162
        return False
124
163
 
125
164
 
126
 
 
127
165
def isfile(f):
128
166
    """True if f is a regular file."""
129
167
    try:
131
169
    except OSError:
132
170
        return False
133
171
 
 
172
def islink(f):
 
173
    """True if f is a symlink."""
 
174
    try:
 
175
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
176
    except OSError:
 
177
        return False
134
178
 
135
179
def is_inside(dir, fname):
136
180
    """True if fname is inside dir.
142
186
    The empty string as a dir name is taken as top-of-tree and matches 
143
187
    everything.
144
188
    
145
 
    >>> is_inside('src', 'src/foo.c')
 
189
    >>> is_inside('src', os.path.join('src', 'foo.c'))
146
190
    True
147
191
    >>> is_inside('src', 'srccontrol')
148
192
    False
149
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
 
193
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
150
194
    True
151
195
    >>> is_inside('foo.c', 'foo.c')
152
196
    True
162
206
    
163
207
    if dir == '':
164
208
        return True
165
 
    
 
209
 
166
210
    if dir[-1] != os.sep:
167
211
        dir += os.sep
168
 
    
 
212
 
169
213
    return fname.startswith(dir)
170
214
 
171
215
 
183
227
    tofile.write(fromfile.read())
184
228
 
185
229
 
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
230
def sha_file(f):
195
 
    import sha
196
231
    if hasattr(f, 'tell'):
197
232
        assert f.tell() == 0
198
233
    s = sha.new()
205
240
    return s.hexdigest()
206
241
 
207
242
 
 
243
 
 
244
def sha_strings(strings):
 
245
    """Return the sha-1 of concatenation of strings"""
 
246
    s = sha.new()
 
247
    map(s.update, strings)
 
248
    return s.hexdigest()
 
249
 
 
250
 
208
251
def sha_string(f):
209
 
    import sha
210
252
    s = sha.new()
211
253
    s.update(f)
212
254
    return s.hexdigest()
213
255
 
214
256
 
215
 
 
216
257
def fingerprint_file(f):
217
 
    import sha
218
258
    s = sha.new()
219
259
    b = f.read()
220
260
    s.update(b)
223
263
            'sha1': s.hexdigest()}
224
264
 
225
265
 
226
 
def config_dir():
227
 
    """Return per-user configuration directory.
228
 
 
229
 
    By default this is ~/.bzr.conf/
230
 
    
231
 
    TODO: Global option --config-dir to override this.
232
 
    """
233
 
    return os.path.expanduser("~/.bzr.conf")
234
 
 
235
 
 
236
 
def _auto_user_id():
237
 
    """Calculate automatic user identification.
238
 
 
239
 
    Returns (realname, email).
240
 
 
241
 
    Only used when none is set in the environment or the id file.
242
 
 
243
 
    This previously used the FQDN as the default domain, but that can
244
 
    be very slow on machines where DNS is broken.  So now we simply
245
 
    use the hostname.
246
 
    """
247
 
    import socket
248
 
 
249
 
    # XXX: Any good way to get real user name on win32?
250
 
 
251
 
    try:
252
 
        import pwd
253
 
        uid = os.getuid()
254
 
        w = pwd.getpwuid(uid)
255
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
256
 
        username = w.pw_name.decode(bzrlib.user_encoding)
257
 
        comma = gecos.find(',')
258
 
        if comma == -1:
259
 
            realname = gecos
260
 
        else:
261
 
            realname = gecos[:comma]
262
 
        if not realname:
263
 
            realname = username
264
 
 
265
 
    except ImportError:
266
 
        import getpass
267
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
268
 
 
269
 
    return realname, (username + '@' + socket.gethostname())
270
 
 
271
 
 
272
 
def _get_user_id():
273
 
    """Return the full user id from a file or environment variable.
274
 
 
275
 
    TODO: Allow taking this from a file in the branch directory too
276
 
    for per-branch ids."""
277
 
    v = os.environ.get('BZREMAIL')
278
 
    if v:
279
 
        return v.decode(bzrlib.user_encoding)
280
 
    
281
 
    try:
282
 
        return (open(os.path.join(config_dir(), "email"))
283
 
                .read()
284
 
                .decode(bzrlib.user_encoding)
285
 
                .rstrip("\r\n"))
286
 
    except IOError, e:
287
 
        if e.errno != errno.ENOENT:
288
 
            raise e
289
 
 
290
 
    v = os.environ.get('EMAIL')
291
 
    if v:
292
 
        return v.decode(bzrlib.user_encoding)
293
 
    else:    
294
 
        return None
295
 
 
296
 
 
297
 
def username():
298
 
    """Return email-style username.
299
 
 
300
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
301
 
 
302
 
    TODO: Check it's reasonably well-formed.
303
 
    """
304
 
    v = _get_user_id()
305
 
    if v:
306
 
        return v
307
 
    
308
 
    name, email = _auto_user_id()
309
 
    if name:
310
 
        return '%s <%s>' % (name, email)
311
 
    else:
312
 
        return email
313
 
 
314
 
 
315
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
316
 
def user_email():
317
 
    """Return just the email component of a username."""
318
 
    e = _get_user_id()
319
 
    if e:
320
 
        m = _EMAIL_RE.search(e)
321
 
        if not m:
322
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
323
 
        return m.group(0)
324
 
 
325
 
    return _auto_user_id()[1]
326
 
    
327
 
 
328
 
 
329
266
def compare_files(a, b):
330
267
    """Returns true if equal in contents"""
331
268
    BUFSIZE = 4096
338
275
            return True
339
276
 
340
277
 
341
 
 
342
278
def local_time_offset(t=None):
343
279
    """Return offset of local zone from GMT, either at present or at time t."""
344
280
    # python2.3 localtime() can't take None
383
319
    """Return size of given open file."""
384
320
    return os.fstat(f.fileno())[ST_SIZE]
385
321
 
386
 
 
387
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
322
# Define rand_bytes based on platform.
 
323
try:
 
324
    # Python 2.4 and later have os.urandom,
 
325
    # but it doesn't work on some arches
 
326
    os.urandom(1)
388
327
    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
 
 
 
328
except (NotImplementedError, AttributeError):
 
329
    # If python doesn't have os.urandom, or it doesn't work,
 
330
    # then try to first pull random data from /dev/urandom
 
331
    if os.path.exists("/dev/urandom"):
 
332
        rand_bytes = file('/dev/urandom', 'rb').read
 
333
    # Otherwise, use this hack as a last resort
 
334
    else:
 
335
        # not well seeded, but better than nothing
 
336
        def rand_bytes(n):
 
337
            import random
 
338
            s = ''
 
339
            while n:
 
340
                s += chr(random.randint(0, 255))
 
341
                n -= 1
 
342
            return s
401
343
 
402
344
## TODO: We could later have path objects that remember their list
403
345
## decomposition (might be too tricksy though.)
449
391
        return os.path.join(p1, p2)
450
392
    
451
393
 
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
 
def _read_config_value(name):
460
 
    """Read a config value from the file ~/.bzr.conf/<name>
461
 
    Return None if the file does not exist"""
462
 
    try:
463
 
        f = file(os.path.join(config_dir(), name), "r")
464
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
465
 
    except IOError, e:
466
 
        if e.errno == errno.ENOENT:
467
 
            return None
468
 
        raise
469
 
 
470
 
 
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
 
        
507
 
    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
 
394
def split_lines(s):
 
395
    """Split s into lines, but without removing the newline characters."""
 
396
    return StringIO(s).readlines()
 
397
 
 
398
 
 
399
def hardlinks_good():
 
400
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
401
 
 
402
 
 
403
def link_or_copy(src, dest):
 
404
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
405
    if not hardlinks_good():
 
406
        copyfile(src, dest)
 
407
        return
 
408
    try:
 
409
        os.link(src, dest)
 
410
    except (OSError, IOError), e:
 
411
        if e.errno != errno.EXDEV:
 
412
            raise
 
413
        copyfile(src, dest)
 
414
 
 
415
 
 
416
def has_symlinks():
 
417
    if hasattr(os, 'symlink'):
 
418
        return True
 
419
    else:
 
420
        return False