/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, types
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from errors import bailout
23
 
 
24
 
def make_readonly(filename):
25
 
    """Make a filename read-only."""
26
 
    # TODO: probably needs to be fixed for windows
27
 
    mod = os.stat(filename).st_mode
28
 
    mod = mod & 0777555
29
 
    os.chmod(filename, mod)
30
 
 
31
 
 
32
 
def make_writable(filename):
33
 
    mod = os.stat(filename).st_mode
34
 
    mod = mod | 0200
35
 
    os.chmod(filename, mod)
36
 
 
37
 
 
38
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
39
 
def quotefn(f):
40
 
    """Return shell-quoted filename"""
41
 
    ## We could be a bit more terse by using double-quotes etc
42
 
    f = _QUOTE_RE.sub(r'\\\1', f)
43
 
    if f[0] == '~':
44
 
        f[0:1] = r'\~' 
45
 
    return f
46
 
 
47
 
 
48
 
def file_kind(f):
49
 
    mode = os.lstat(f)[ST_MODE]
50
 
    if S_ISREG(mode):
51
 
        return 'file'
52
 
    elif S_ISDIR(mode):
53
 
        return 'directory'
54
 
    elif S_ISLNK(mode):
55
 
        return 'symlink'
56
 
    else:
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
58
 
 
59
 
 
60
 
 
61
 
def isdir(f):
62
 
    """True if f is an accessible directory."""
63
 
    try:
64
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
65
 
    except OSError:
66
 
        return False
67
 
 
68
 
 
69
 
 
70
 
def isfile(f):
71
 
    """True if f is a regular file."""
72
 
    try:
73
 
        return S_ISREG(os.lstat(f)[ST_MODE])
74
 
    except OSError:
75
 
        return False
76
 
 
77
 
 
78
 
def pumpfile(fromfile, tofile):
79
 
    """Copy contents of one file to another."""
80
 
    tofile.write(fromfile.read())
81
 
 
82
 
 
83
 
def uuid():
84
 
    """Return a new UUID"""
85
 
    
86
 
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
87
 
    ## Linux, but we need something portable for other systems;
88
 
    ## preferably an implementation in Python.
89
 
    try:
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
91
 
    except IOError:
92
 
        return chomp(os.popen('uuidgen').readline())
93
 
 
94
 
 
95
 
def chomp(s):
96
 
    if s and (s[-1] == '\n'):
97
 
        return s[:-1]
98
 
    else:
99
 
        return s
100
 
 
101
 
 
102
 
def sha_file(f):
103
 
    import sha
104
 
    ## TODO: Maybe read in chunks to handle big files
105
 
    if hasattr(f, 'tell'):
106
 
        assert f.tell() == 0
107
 
    s = sha.new()
108
 
    s.update(f.read())
109
 
    return s.hexdigest()
110
 
 
111
 
 
112
 
def sha_string(f):
113
 
    import sha
114
 
    s = sha.new()
115
 
    s.update(f)
116
 
    return s.hexdigest()
117
 
 
118
 
 
119
 
 
120
 
def fingerprint_file(f):
121
 
    import sha
122
 
    s = sha.new()
123
 
    b = f.read()
124
 
    s.update(b)
125
 
    size = len(b)
126
 
    return {'size': size,
127
 
            'sha1': s.hexdigest()}
128
 
 
129
 
 
130
 
 
131
 
def username():
132
 
    """Return email-style username.
133
 
 
134
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
135
 
 
136
 
    :todo: Check it's reasonably well-formed.
137
 
 
138
 
    :todo: Allow taking it from a dotfile to help people on windows
139
 
           who can't easily set variables.
140
 
 
141
 
    :todo: Cope without pwd module, which is only on unix. 
142
 
    """
143
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
144
 
    if e: return e
145
 
 
146
 
    import socket
147
 
    
148
 
    try:
149
 
        import pwd
150
 
        uid = os.getuid()
151
 
        w = pwd.getpwuid(uid)
152
 
        gecos = w.pw_gecos
153
 
        comma = gecos.find(',')
154
 
        if comma == -1:
155
 
            realname = gecos
156
 
        else:
157
 
            realname = gecos[:comma]
158
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
159
 
    except ImportError:
160
 
        pass
161
 
 
162
 
    import getpass, socket
163
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
164
 
 
165
 
 
166
 
def user_email():
167
 
    """Return just the email component of a username."""
168
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
169
 
    if e:
170
 
        import re
171
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
172
 
        if not m:
173
 
            bailout('%r is not a reasonable email address' % e)
174
 
        return m.group(0)
175
 
 
176
 
 
177
 
    import getpass, socket
178
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
179
 
 
180
 
    
181
 
 
182
 
 
183
 
def compare_files(a, b):
184
 
    """Returns true if equal in contents"""
185
 
    # TODO: don't read the whole thing in one go.
186
 
    BUFSIZE = 4096
187
 
    while True:
188
 
        ai = a.read(BUFSIZE)
189
 
        bi = b.read(BUFSIZE)
190
 
        if ai != bi:
191
 
            return False
192
 
        if ai == '':
193
 
            return True
194
 
 
195
 
 
196
 
 
197
 
def local_time_offset(t=None):
198
 
    """Return offset of local zone from GMT, either at present or at time t."""
199
 
    # python2.3 localtime() can't take None
200
 
    if t is None:
201
 
        t = time.time()
202
 
        
203
 
    if time.localtime(t).tm_isdst and time.daylight:
204
 
        return -time.altzone
205
 
    else:
206
 
        return -time.timezone
207
 
 
208
 
    
209
 
def format_date(t, offset=0, timezone='original'):
210
 
    ## TODO: Perhaps a global option to use either universal or local time?
211
 
    ## Or perhaps just let people set $TZ?
212
 
    import time
213
 
    
214
 
    assert isinstance(t, float)
215
 
    
216
 
    if timezone == 'utc':
217
 
        tt = time.gmtime(t)
218
 
        offset = 0
219
 
    elif timezone == 'original':
220
 
        if offset == None:
221
 
            offset = 0
222
 
        tt = time.gmtime(t + offset)
223
 
    elif timezone == 'local':
224
 
        tt = time.localtime(t)
225
 
        offset = local_time_offset(t)
226
 
    else:
227
 
        bailout("unsupported timezone format %r",
228
 
                ['options are "utc", "original", "local"'])
229
 
 
230
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
231
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
232
 
 
233
 
 
234
 
def compact_date(when):
235
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
236
 
    
237
 
 
238
 
 
239
 
def filesize(f):
240
 
    """Return size of given open file."""
241
 
    return os.fstat(f.fileno())[ST_SIZE]
242
 
 
243
 
 
244
 
if hasattr(os, 'urandom'): # python 2.4 and later
245
 
    rand_bytes = os.urandom
246
 
else:
247
 
    # FIXME: No good on non-Linux
248
 
    _rand_file = file('/dev/urandom', 'rb')
249
 
    rand_bytes = _rand_file.read
250
 
 
251
 
 
252
 
## TODO: We could later have path objects that remember their list
253
 
## decomposition (might be too tricksy though.)
254
 
 
255
 
def splitpath(p):
256
 
    """Turn string into list of parts.
257
 
 
258
 
    >>> splitpath('a')
259
 
    ['a']
260
 
    >>> splitpath('a/b')
261
 
    ['a', 'b']
262
 
    >>> splitpath('a/./b')
263
 
    ['a', 'b']
264
 
    >>> splitpath('a/.b')
265
 
    ['a', '.b']
266
 
    >>> splitpath('a/../b')
267
 
    Traceback (most recent call last):
268
 
    ...
269
 
    BzrError: ("sorry, '..' not allowed in path", [])
270
 
    """
271
 
    assert isinstance(p, types.StringTypes)
272
 
    ps = [f for f in p.split('/') if f != '.']
273
 
    for f in ps:
274
 
        if f == '..':
275
 
            bailout("sorry, %r not allowed in path" % f)
276
 
    return ps
277
 
 
278
 
def joinpath(p):
279
 
    assert isinstance(p, list)
280
 
    for f in p:
281
 
        if (f == '..') or (f is None) or (f == ''):
282
 
            bailout("sorry, %r not allowed in path" % f)
283
 
    return '/'.join(p)
284
 
 
285
 
 
286
 
def appendpath(p1, p2):
287
 
    if p1 == '':
288
 
        return p2
289
 
    else:
290
 
        return p1 + '/' + p2
291
 
    
292
 
 
293
 
def extern_command(cmd, ignore_errors = False):
294
 
    mutter('external command: %s' % `cmd`)
295
 
    if os.system(cmd):
296
 
        if not ignore_errors:
297
 
            bailout('command failed')
298