~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

Merge in format-5 work - release bzr 0.1rc1.

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
 
19
from shutil import copyfile
20
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
        S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
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
22
30
 
 
31
import bzrlib
23
32
from bzrlib.errors import BzrError
24
33
from bzrlib.trace import mutter
25
 
import bzrlib
 
34
 
26
35
 
27
36
def make_readonly(filename):
28
37
    """Make a filename read-only."""
29
 
    # TODO: probably needs to be fixed for windows
30
38
    mod = os.stat(filename).st_mode
31
39
    mod = mod & 0777555
32
40
    os.chmod(filename, mod)
49
57
    # TODO: I'm not really sure this is the best format either.x
50
58
    global _QUOTE_RE
51
59
    if _QUOTE_RE == None:
52
 
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
60
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
53
61
        
54
62
    if _QUOTE_RE.search(f):
55
63
        return '"' + f + '"'
87
95
    else:
88
96
        raise BzrError('invalid file kind %r' % kind)
89
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))
90
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
    
91
122
 
92
123
def backup_file(fn):
93
124
    """Copy a file to a backup.
96
127
 
97
128
    If the file is already a backup, it's not copied.
98
129
    """
99
 
    import os
100
130
    if fn[-1] == '~':
101
131
        return
102
132
    bfn = fn + '~'
113
143
    finally:
114
144
        outf.close()
115
145
 
116
 
def rename(path_from, path_to):
117
 
    """Basically the same as os.rename() just special for win32"""
118
 
    if sys.platform == 'win32':
119
 
        try:
120
 
            os.remove(path_to)
121
 
        except OSError, e:
122
 
            if e.errno != e.ENOENT:
123
 
                raise
124
 
    os.rename(path_from, path_to)
125
 
 
126
 
 
127
 
 
 
146
if os.name == 'nt':
 
147
    import shutil
 
148
    rename = shutil.move
 
149
else:
 
150
    rename = os.rename
128
151
 
129
152
 
130
153
def isdir(f):
135
158
        return False
136
159
 
137
160
 
138
 
 
139
161
def isfile(f):
140
162
    """True if f is a regular file."""
141
163
    try:
143
165
    except OSError:
144
166
        return False
145
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
146
174
 
147
175
def is_inside(dir, fname):
148
176
    """True if fname is inside dir.
154
182
    The empty string as a dir name is taken as top-of-tree and matches 
155
183
    everything.
156
184
    
157
 
    >>> is_inside('src', 'src/foo.c')
 
185
    >>> is_inside('src', os.path.join('src', 'foo.c'))
158
186
    True
159
187
    >>> is_inside('src', 'srccontrol')
160
188
    False
161
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
 
189
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
162
190
    True
163
191
    >>> is_inside('foo.c', 'foo.c')
164
192
    True
174
202
    
175
203
    if dir == '':
176
204
        return True
177
 
    
 
205
 
178
206
    if dir[-1] != os.sep:
179
207
        dir += os.sep
180
 
    
 
208
 
181
209
    return fname.startswith(dir)
182
210
 
183
211
 
195
223
    tofile.write(fromfile.read())
196
224
 
197
225
 
198
 
def uuid():
199
 
    """Return a new UUID"""
200
 
    try:
201
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
202
 
    except IOError:
203
 
        return chomp(os.popen('uuidgen').readline())
204
 
 
205
 
 
206
226
def sha_file(f):
207
 
    import sha
208
227
    if hasattr(f, 'tell'):
209
228
        assert f.tell() == 0
210
229
    s = sha.new()
217
236
    return s.hexdigest()
218
237
 
219
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
 
220
247
def sha_string(f):
221
 
    import sha
222
248
    s = sha.new()
223
249
    s.update(f)
224
250
    return s.hexdigest()
225
251
 
226
252
 
227
 
 
228
253
def fingerprint_file(f):
229
 
    import sha
230
254
    s = sha.new()
231
255
    b = f.read()
232
256
    s.update(b)
242
266
    
243
267
    TODO: Global option --config-dir to override this.
244
268
    """
245
 
    return os.path.expanduser("~/.bzr.conf")
 
269
    return os.path.join(os.path.expanduser("~"), ".bzr.conf")
246
270
 
247
271
 
248
272
def _auto_user_id():
352
376
    if e:
353
377
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
354
378
        if not m:
355
 
            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)
356
381
        return m.group(0)
357
382
 
358
383
    return _auto_user_id()[1]
359
 
    
360
384
 
361
385
 
362
386
def compare_files(a, b):
371
395
            return True
372
396
 
373
397
 
374
 
 
375
398
def local_time_offset(t=None):
376
399
    """Return offset of local zone from GMT, either at present or at time t."""
377
400
    # python2.3 localtime() can't take None
488
511
        return os.path.join(p1, p2)
489
512
    
490
513
 
491
 
def extern_command(cmd, ignore_errors = False):
492
 
    mutter('external command: %s' % `cmd`)
493
 
    if os.system(cmd):
494
 
        if not ignore_errors:
495
 
            raise BzrError('command failed')
496
 
 
497
 
 
498
514
def _read_config_value(name):
499
515
    """Read a config value from the file ~/.bzr.conf/<name>
500
516
    Return None if the file does not exist"""
507
523
        raise
508
524
 
509
525
 
 
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
 
540
    try:
 
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