/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

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
5
 
# This program is free software; you can redistribute it and/or modify
6
 
# it under the terms of the GNU General Public License as published by
7
 
# the Free Software Foundation; either version 2 of the License, or
8
 
# (at your option) any later version.
9
 
 
10
 
# This program is distributed in the hope that it will be useful,
11
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
# GNU General Public License for more details.
14
 
 
15
 
# You should have received a copy of the GNU General Public License
16
 
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
 
 
19
 
import os, types, re, time, errno, sys
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
24
 
import bzrlib
25
 
 
26
 
def make_readonly(filename):
27
 
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
 
    mod = os.stat(filename).st_mode
30
 
    mod = mod & 0777555
31
 
    os.chmod(filename, mod)
32
 
 
33
 
 
34
 
def make_writable(filename):
35
 
    mod = os.stat(filename).st_mode
36
 
    mod = mod | 0200
37
 
    os.chmod(filename, mod)
38
 
 
39
 
 
40
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
41
 
def quotefn(f):
42
 
    """Return shell-quoted filename"""
43
 
    ## We could be a bit more terse by using double-quotes etc
44
 
    f = _QUOTE_RE.sub(r'\\\1', f)
45
 
    if f[0] == '~':
46
 
        f[0:1] = r'\~' 
47
 
    return f
48
 
 
49
 
 
50
 
def file_kind(f):
51
 
    mode = os.lstat(f)[ST_MODE]
52
 
    if S_ISREG(mode):
53
 
        return 'file'
54
 
    elif S_ISDIR(mode):
55
 
        return 'directory'
56
 
    elif S_ISLNK(mode):
57
 
        return 'symlink'
58
 
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
60
 
 
61
 
 
62
 
def kind_marker(kind):
63
 
    if kind == 'file':
64
 
        return ''
65
 
    elif kind == 'directory':
66
 
        return '/'
67
 
    elif kind == 'symlink':
68
 
        return '@'
69
 
    else:
70
 
        raise BzrError('invalid file kind %r' % kind)
71
 
 
72
 
 
73
 
 
74
 
def isdir(f):
75
 
    """True if f is an accessible directory."""
76
 
    try:
77
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
78
 
    except OSError:
79
 
        return False
80
 
 
81
 
 
82
 
 
83
 
def isfile(f):
84
 
    """True if f is a regular file."""
85
 
    try:
86
 
        return S_ISREG(os.lstat(f)[ST_MODE])
87
 
    except OSError:
88
 
        return False
89
 
 
90
 
 
91
 
def is_inside(dir, fname):
92
 
    """True if fname is inside dir.
93
 
    """
94
 
    return os.path.commonprefix([dir, fname]) == dir
95
 
 
96
 
 
97
 
def is_inside_any(dir_list, fname):
98
 
    """True if fname is inside any of given dirs."""
99
 
    # quick scan for perfect match
100
 
    if fname in dir_list:
101
 
        return True
102
 
    
103
 
    for dirname in dir_list:
104
 
        if is_inside(dirname, fname):
105
 
            return True
106
 
    else:
107
 
        return False
108
 
 
109
 
 
110
 
def pumpfile(fromfile, tofile):
111
 
    """Copy contents of one file to another."""
112
 
    tofile.write(fromfile.read())
113
 
 
114
 
 
115
 
def uuid():
116
 
    """Return a new UUID"""
117
 
    try:
118
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
119
 
    except IOError:
120
 
        return chomp(os.popen('uuidgen').readline())
121
 
 
122
 
 
123
 
def sha_file(f):
124
 
    import sha
125
 
    if hasattr(f, 'tell'):
126
 
        assert f.tell() == 0
127
 
    s = sha.new()
128
 
    BUFSIZE = 128<<10
129
 
    while True:
130
 
        b = f.read(BUFSIZE)
131
 
        if not b:
132
 
            break
133
 
        s.update(b)
134
 
    return s.hexdigest()
135
 
 
136
 
 
137
 
def sha_string(f):
138
 
    import sha
139
 
    s = sha.new()
140
 
    s.update(f)
141
 
    return s.hexdigest()
142
 
 
143
 
 
144
 
 
145
 
def fingerprint_file(f):
146
 
    import sha
147
 
    s = sha.new()
148
 
    b = f.read()
149
 
    s.update(b)
150
 
    size = len(b)
151
 
    return {'size': size,
152
 
            'sha1': s.hexdigest()}
153
 
 
154
 
 
155
 
def config_dir():
156
 
    """Return per-user configuration directory.
157
 
 
158
 
    By default this is ~/.bzr.conf/
159
 
    
160
 
    TODO: Global option --config-dir to override this.
161
 
    """
162
 
    return os.path.expanduser("~/.bzr.conf")
163
 
 
164
 
 
165
 
def _auto_user_id():
166
 
    """Calculate automatic user identification.
167
 
 
168
 
    Returns (realname, email).
169
 
 
170
 
    Only used when none is set in the environment or the id file.
171
 
 
172
 
    This previously used the FQDN as the default domain, but that can
173
 
    be very slow on machines where DNS is broken.  So now we simply
174
 
    use the hostname.
175
 
    """
176
 
    import socket
177
 
 
178
 
    # XXX: Any good way to get real user name on win32?
179
 
 
180
 
    try:
181
 
        import pwd
182
 
        uid = os.getuid()
183
 
        w = pwd.getpwuid(uid)
184
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
185
 
        username = w.pw_name.decode(bzrlib.user_encoding)
186
 
        comma = gecos.find(',')
187
 
        if comma == -1:
188
 
            realname = gecos
189
 
        else:
190
 
            realname = gecos[:comma]
191
 
        if not realname:
192
 
            realname = username
193
 
 
194
 
    except ImportError:
195
 
        import getpass
196
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
197
 
 
198
 
    return realname, (username + '@' + socket.gethostname())
199
 
 
200
 
 
201
 
def _get_user_id():
202
 
    """Return the full user id from a file or environment variable.
203
 
 
204
 
    TODO: Allow taking this from a file in the branch directory too
205
 
    for per-branch ids."""
206
 
    v = os.environ.get('BZREMAIL')
207
 
    if v:
208
 
        return v.decode(bzrlib.user_encoding)
209
 
    
210
 
    try:
211
 
        return (open(os.path.join(config_dir(), "email"))
212
 
                .read()
213
 
                .decode(bzrlib.user_encoding)
214
 
                .rstrip("\r\n"))
215
 
    except IOError, e:
216
 
        if e.errno != errno.ENOENT:
217
 
            raise e
218
 
 
219
 
    v = os.environ.get('EMAIL')
220
 
    if v:
221
 
        return v.decode(bzrlib.user_encoding)
222
 
    else:    
223
 
        return None
224
 
 
225
 
 
226
 
def username():
227
 
    """Return email-style username.
228
 
 
229
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
230
 
 
231
 
    TODO: Check it's reasonably well-formed.
232
 
    """
233
 
    v = _get_user_id()
234
 
    if v:
235
 
        return v
236
 
    
237
 
    name, email = _auto_user_id()
238
 
    if name:
239
 
        return '%s <%s>' % (name, email)
240
 
    else:
241
 
        return email
242
 
 
243
 
 
244
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
245
 
def user_email():
246
 
    """Return just the email component of a username."""
247
 
    e = _get_user_id()
248
 
    if e:
249
 
        m = _EMAIL_RE.search(e)
250
 
        if not m:
251
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
252
 
        return m.group(0)
253
 
 
254
 
    return _auto_user_id()[1]
255
 
    
256
 
 
257
 
 
258
 
def compare_files(a, b):
259
 
    """Returns true if equal in contents"""
260
 
    BUFSIZE = 4096
261
 
    while True:
262
 
        ai = a.read(BUFSIZE)
263
 
        bi = b.read(BUFSIZE)
264
 
        if ai != bi:
265
 
            return False
266
 
        if ai == '':
267
 
            return True
268
 
 
269
 
 
270
 
 
271
 
def local_time_offset(t=None):
272
 
    """Return offset of local zone from GMT, either at present or at time t."""
273
 
    # python2.3 localtime() can't take None
274
 
    if t == None:
275
 
        t = time.time()
276
 
        
277
 
    if time.localtime(t).tm_isdst and time.daylight:
278
 
        return -time.altzone
279
 
    else:
280
 
        return -time.timezone
281
 
 
282
 
    
283
 
def format_date(t, offset=0, timezone='original'):
284
 
    ## TODO: Perhaps a global option to use either universal or local time?
285
 
    ## Or perhaps just let people set $TZ?
286
 
    assert isinstance(t, float)
287
 
    
288
 
    if timezone == 'utc':
289
 
        tt = time.gmtime(t)
290
 
        offset = 0
291
 
    elif timezone == 'original':
292
 
        if offset == None:
293
 
            offset = 0
294
 
        tt = time.gmtime(t + offset)
295
 
    elif timezone == 'local':
296
 
        tt = time.localtime(t)
297
 
        offset = local_time_offset(t)
298
 
    else:
299
 
        bailout("unsupported timezone format %r",
300
 
                ['options are "utc", "original", "local"'])
301
 
 
302
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
303
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
304
 
 
305
 
 
306
 
def compact_date(when):
307
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
308
 
    
309
 
 
310
 
 
311
 
def filesize(f):
312
 
    """Return size of given open file."""
313
 
    return os.fstat(f.fileno())[ST_SIZE]
314
 
 
315
 
 
316
 
if hasattr(os, 'urandom'): # python 2.4 and later
317
 
    rand_bytes = os.urandom
318
 
elif sys.platform == 'linux2':
319
 
    rand_bytes = file('/dev/urandom', 'rb').read
320
 
else:
321
 
    # not well seeded, but better than nothing
322
 
    def rand_bytes(n):
323
 
        import random
324
 
        s = ''
325
 
        while n:
326
 
            s += chr(random.randint(0, 255))
327
 
            n -= 1
328
 
        return s
329
 
 
330
 
 
331
 
## TODO: We could later have path objects that remember their list
332
 
## decomposition (might be too tricksy though.)
333
 
 
334
 
def splitpath(p):
335
 
    """Turn string into list of parts.
336
 
 
337
 
    >>> splitpath('a')
338
 
    ['a']
339
 
    >>> splitpath('a/b')
340
 
    ['a', 'b']
341
 
    >>> splitpath('a/./b')
342
 
    ['a', 'b']
343
 
    >>> splitpath('a/.b')
344
 
    ['a', '.b']
345
 
    >>> splitpath('a/../b')
346
 
    Traceback (most recent call last):
347
 
    ...
348
 
    BzrError: ("sorry, '..' not allowed in path", [])
349
 
    """
350
 
    assert isinstance(p, types.StringTypes)
351
 
 
352
 
    # split on either delimiter because people might use either on
353
 
    # Windows
354
 
    ps = re.split(r'[\\/]', p)
355
 
 
356
 
    rps = []
357
 
    for f in ps:
358
 
        if f == '..':
359
 
            bailout("sorry, %r not allowed in path" % f)
360
 
        elif (f == '.') or (f == ''):
361
 
            pass
362
 
        else:
363
 
            rps.append(f)
364
 
    return rps
365
 
 
366
 
def joinpath(p):
367
 
    assert isinstance(p, list)
368
 
    for f in p:
369
 
        if (f == '..') or (f == None) or (f == ''):
370
 
            bailout("sorry, %r not allowed in path" % f)
371
 
    return os.path.join(*p)
372
 
 
373
 
 
374
 
def appendpath(p1, p2):
375
 
    if p1 == '':
376
 
        return p2
377
 
    else:
378
 
        return os.path.join(p1, p2)
379
 
    
380
 
 
381
 
def extern_command(cmd, ignore_errors = False):
382
 
    mutter('external command: %s' % `cmd`)
383
 
    if os.system(cmd):
384
 
        if not ignore_errors:
385
 
            bailout('command failed')
386