/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-09-29 00:24:44 UTC
  • Revision ID: robertc@robertcollins.net-20050929002444-76fe66e99fb9bcd5
reinstate testfetch test case

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):
76
96
        raise BzrError('invalid file kind %r' % kind)
77
97
 
78
98
 
79
 
 
80
99
def backup_file(fn):
81
100
    """Copy a file to a backup.
82
101
 
84
103
 
85
104
    If the file is already a backup, it's not copied.
86
105
    """
87
 
    import os
88
106
    if fn[-1] == '~':
89
107
        return
90
108
    bfn = fn + '~'
101
119
    finally:
102
120
        outf.close()
103
121
 
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
 
 
 
122
if os.name == 'nt':
 
123
    import shutil
 
124
    rename = shutil.move
 
125
else:
 
126
    rename = os.rename
116
127
 
117
128
 
118
129
def isdir(f):
123
134
        return False
124
135
 
125
136
 
126
 
 
127
137
def isfile(f):
128
138
    """True if f is a regular file."""
129
139
    try:
142
152
    The empty string as a dir name is taken as top-of-tree and matches 
143
153
    everything.
144
154
    
145
 
    >>> is_inside('src', 'src/foo.c')
 
155
    >>> is_inside('src', os.path.join('src', 'foo.c'))
146
156
    True
147
157
    >>> is_inside('src', 'srccontrol')
148
158
    False
149
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
 
159
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
150
160
    True
151
161
    >>> is_inside('foo.c', 'foo.c')
152
162
    True
162
172
    
163
173
    if dir == '':
164
174
        return True
165
 
    
 
175
 
166
176
    if dir[-1] != os.sep:
167
177
        dir += os.sep
168
 
    
 
178
 
169
179
    return fname.startswith(dir)
170
180
 
171
181
 
183
193
    tofile.write(fromfile.read())
184
194
 
185
195
 
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
196
def sha_file(f):
195
 
    import sha
196
197
    if hasattr(f, 'tell'):
197
198
        assert f.tell() == 0
198
199
    s = sha.new()
205
206
    return s.hexdigest()
206
207
 
207
208
 
 
209
 
 
210
def sha_strings(strings):
 
211
    """Return the sha-1 of concatenation of strings"""
 
212
    s = sha.new()
 
213
    map(s.update, strings)
 
214
    return s.hexdigest()
 
215
 
 
216
 
208
217
def sha_string(f):
209
 
    import sha
210
218
    s = sha.new()
211
219
    s.update(f)
212
220
    return s.hexdigest()
213
221
 
214
222
 
215
 
 
216
223
def fingerprint_file(f):
217
 
    import sha
218
224
    s = sha.new()
219
225
    b = f.read()
220
226
    s.update(b)
230
236
    
231
237
    TODO: Global option --config-dir to override this.
232
238
    """
233
 
    return os.path.expanduser("~/.bzr.conf")
 
239
    return os.path.join(os.path.expanduser("~"), ".bzr.conf")
234
240
 
235
241
 
236
242
def _auto_user_id():
269
275
    return realname, (username + '@' + socket.gethostname())
270
276
 
271
277
 
272
 
def _get_user_id():
 
278
def _get_user_id(branch):
273
279
    """Return the full user id from a file or environment variable.
274
280
 
275
 
    TODO: Allow taking this from a file in the branch directory too
276
 
    for per-branch ids."""
 
281
    e.g. "John Hacker <jhacker@foo.org>"
 
282
 
 
283
    branch
 
284
        A branch to use for a per-branch configuration, or None.
 
285
 
 
286
    The following are searched in order:
 
287
 
 
288
    1. $BZREMAIL
 
289
    2. .bzr/email for this branch.
 
290
    3. ~/.bzr.conf/email
 
291
    4. $EMAIL
 
292
    """
277
293
    v = os.environ.get('BZREMAIL')
278
294
    if v:
279
295
        return v.decode(bzrlib.user_encoding)
 
296
 
 
297
    if branch:
 
298
        try:
 
299
            return (branch.controlfile("email", "r") 
 
300
                    .read()
 
301
                    .decode(bzrlib.user_encoding)
 
302
                    .rstrip("\r\n"))
 
303
        except IOError, e:
 
304
            if e.errno != errno.ENOENT:
 
305
                raise
 
306
        except BzrError, e:
 
307
            pass
280
308
    
281
309
    try:
282
310
        return (open(os.path.join(config_dir(), "email"))
294
322
        return None
295
323
 
296
324
 
297
 
def username():
 
325
def username(branch):
298
326
    """Return email-style username.
299
327
 
300
328
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
301
329
 
302
330
    TODO: Check it's reasonably well-formed.
303
331
    """
304
 
    v = _get_user_id()
 
332
    v = _get_user_id(branch)
305
333
    if v:
306
334
        return v
307
335
    
312
340
        return email
313
341
 
314
342
 
315
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
316
 
def user_email():
 
343
def user_email(branch):
317
344
    """Return just the email component of a username."""
318
 
    e = _get_user_id()
 
345
    e = _get_user_id(branch)
319
346
    if e:
320
 
        m = _EMAIL_RE.search(e)
 
347
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
321
348
        if not m:
322
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
 
349
            raise BzrError("%r doesn't seem to contain "
 
350
                           "a reasonable email address" % e)
323
351
        return m.group(0)
324
352
 
325
353
    return _auto_user_id()[1]
326
 
    
327
354
 
328
355
 
329
356
def compare_files(a, b):
338
365
            return True
339
366
 
340
367
 
341
 
 
342
368
def local_time_offset(t=None):
343
369
    """Return offset of local zone from GMT, either at present or at time t."""
344
370
    # python2.3 localtime() can't take None
383
409
    """Return size of given open file."""
384
410
    return os.fstat(f.fileno())[ST_SIZE]
385
411
 
386
 
 
387
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
412
# Define rand_bytes based on platform.
 
413
try:
 
414
    # Python 2.4 and later have os.urandom,
 
415
    # but it doesn't work on some arches
 
416
    os.urandom(1)
388
417
    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
 
 
 
418
except (NotImplementedError, AttributeError):
 
419
    # If python doesn't have os.urandom, or it doesn't work,
 
420
    # then try to first pull random data from /dev/urandom
 
421
    if os.path.exists("/dev/urandom"):
 
422
        rand_bytes = file('/dev/urandom', 'rb').read
 
423
    # Otherwise, use this hack as a last resort
 
424
    else:
 
425
        # not well seeded, but better than nothing
 
426
        def rand_bytes(n):
 
427
            import random
 
428
            s = ''
 
429
            while n:
 
430
                s += chr(random.randint(0, 255))
 
431
                n -= 1
 
432
            return s
401
433
 
402
434
## TODO: We could later have path objects that remember their list
403
435
## decomposition (might be too tricksy though.)
449
481
        return os.path.join(p1, p2)
450
482
    
451
483
 
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
484
def _read_config_value(name):
460
485
    """Read a config value from the file ~/.bzr.conf/<name>
461
486
    Return None if the file does not exist"""
468
493
        raise
469
494
 
470
495
 
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
 
        
 
496
def split_lines(s):
 
497
    """Split s into lines, but without removing the newline characters."""
 
498
    return StringIO(s).readlines()
 
499
 
 
500
 
 
501
def hardlinks_good():
 
502
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
503
 
 
504
 
 
505
def link_or_copy(src, dest):
 
506
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
507
    if not hardlinks_good():
 
508
        copyfile(src, dest)
 
509
        return
507
510
    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
 
511
        os.link(src, dest)
 
512
    except (OSError, IOError), e:
 
513
        if e.errno != errno.EXDEV:
 
514
            raise
 
515
        copyfile(src, dest)