← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

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
 
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
 
 
63
def isdir(f):
 
64
    """True if f is an accessible directory."""
 
65
    try:
 
66
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
67
    except OSError:
 
68
        return False
 
69
 
 
70
 
 
71
 
 
72
def isfile(f):
 
73
    """True if f is a regular file."""
 
74
    try:
 
75
        return S_ISREG(os.lstat(f)[ST_MODE])
 
76
    except OSError:
 
77
        return False
 
78
 
 
79
 
 
80
def pumpfile(fromfile, tofile):
 
81
    """Copy contents of one file to another."""
 
82
    tofile.write(fromfile.read())
 
83
 
 
84
 
 
85
def uuid():
 
86
    """Return a new UUID"""
 
87
    
 
88
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
89
    ## Linux, but we need something portable for other systems;
 
90
    ## preferably an implementation in Python.
 
91
    try:
 
92
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
93
    except IOError:
 
94
        return chomp(os.popen('uuidgen').readline())
 
95
 
 
96
 
 
97
def chomp(s):
 
98
    if s and (s[-1] == '\n'):
 
99
        return s[:-1]
 
100
    else:
 
101
        return s
 
102
 
 
103
 
 
104
def sha_file(f):
 
105
    import sha
 
106
    ## TODO: Maybe read in chunks to handle big files
 
107
    if hasattr(f, 'tell'):
 
108
        assert f.tell() == 0
 
109
    s = sha.new()
 
110
    s.update(f.read())
 
111
    return s.hexdigest()
 
112
 
 
113
 
 
114
def sha_string(f):
 
115
    import sha
 
116
    s = sha.new()
 
117
    s.update(f)
 
118
    return s.hexdigest()
 
119
 
 
120
 
 
121
 
 
122
def fingerprint_file(f):
 
123
    import sha
 
124
    s = sha.new()
 
125
    b = f.read()
 
126
    s.update(b)
 
127
    size = len(b)
 
128
    return {'size': size,
 
129
            'sha1': s.hexdigest()}
 
130
 
 
131
 
 
132
def config_dir():
 
133
    """Return per-user configuration directory.
 
134
 
 
135
    By default this is ~/.bzr.conf/
 
136
    
 
137
    TODO: Global option --config-dir to override this.
 
138
    """
 
139
    return os.path.expanduser("~/.bzr.conf")
 
140
 
 
141
 
 
142
def _auto_user_id():
 
143
    """Calculate automatic user identification.
 
144
 
 
145
    Returns (realname, email).
 
146
 
 
147
    Only used when none is set in the environment or the id file.
 
148
 
 
149
    This previously used the FQDN as the default domain, but that can
 
150
    be very slow on machines where DNS is broken.  So now we simply
 
151
    use the hostname.
 
152
    """
 
153
    import socket
 
154
 
 
155
    # XXX: Any good way to get real user name on win32?
 
156
 
 
157
    try:
 
158
        import pwd
 
159
        uid = os.getuid()
 
160
        w = pwd.getpwuid(uid)
 
161
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
162
        username = w.pw_name.decode(bzrlib.user_encoding)
 
163
        comma = gecos.find(',')
 
164
        if comma == -1:
 
165
            realname = gecos
 
166
        else:
 
167
            realname = gecos[:comma]
 
168
        if not realname:
 
169
            realname = username
 
170
 
 
171
    except ImportError:
 
172
        import getpass
 
173
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
 
174
 
 
175
    return realname, (username + '@' + socket.gethostname())
 
176
 
 
177
 
 
178
def _get_user_id():
 
179
    """Return the full user id from a file or environment variable.
 
180
 
 
181
    TODO: Allow taking this from a file in the branch directory too
 
182
    for per-branch ids."""
 
183
    v = os.environ.get('BZREMAIL')
 
184
    if v:
 
185
        return v.decode(bzrlib.user_encoding)
 
186
    
 
187
    try:
 
188
        return (open(os.path.join(config_dir(), "email"))
 
189
                .read()
 
190
                .decode(bzrlib.user_encoding)
 
191
                .rstrip("\r\n"))
 
192
    except IOError, e:
 
193
        if e.errno != errno.ENOENT:
 
194
            raise e
 
195
 
 
196
    v = os.environ.get('EMAIL')
 
197
    if v:
 
198
        return v.decode(bzrlib.user_encoding)
 
199
    else:    
 
200
        return None
 
201
 
 
202
 
 
203
def username():
 
204
    """Return email-style username.
 
205
 
 
206
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
207
 
 
208
    TODO: Check it's reasonably well-formed.
 
209
    """
 
210
    v = _get_user_id()
 
211
    if v:
 
212
        return v
 
213
    
 
214
    name, email = _auto_user_id()
 
215
    if name:
 
216
        return '%s <%s>' % (name, email)
 
217
    else:
 
218
        return email
 
219
 
 
220
 
 
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
222
def user_email():
 
223
    """Return just the email component of a username."""
 
224
    e = _get_user_id()
 
225
    if e:
 
226
        m = _EMAIL_RE.search(e)
 
227
        if not m:
 
228
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
229
        return m.group(0)
 
230
 
 
231
    return _auto_user_id()[1]
 
232
    
 
233
 
 
234
 
 
235
def compare_files(a, b):
 
236
    """Returns true if equal in contents"""
 
237
    # TODO: don't read the whole thing in one go.
 
238
    BUFSIZE = 4096
 
239
    while True:
 
240
        ai = a.read(BUFSIZE)
 
241
        bi = b.read(BUFSIZE)
 
242
        if ai != bi:
 
243
            return False
 
244
        if ai == '':
 
245
            return True
 
246
 
 
247
 
 
248
 
 
249
def local_time_offset(t=None):
 
250
    """Return offset of local zone from GMT, either at present or at time t."""
 
251
    # python2.3 localtime() can't take None
 
252
    if t == None:
 
253
        t = time.time()
 
254
        
 
255
    if time.localtime(t).tm_isdst and time.daylight:
 
256
        return -time.altzone
 
257
    else:
 
258
        return -time.timezone
 
259
 
 
260
    
 
261
def format_date(t, offset=0, timezone='original'):
 
262
    ## TODO: Perhaps a global option to use either universal or local time?
 
263
    ## Or perhaps just let people set $TZ?
 
264
    assert isinstance(t, float)
 
265
    
 
266
    if timezone == 'utc':
 
267
        tt = time.gmtime(t)
 
268
        offset = 0
 
269
    elif timezone == 'original':
 
270
        if offset == None:
 
271
            offset = 0
 
272
        tt = time.gmtime(t + offset)
 
273
    elif timezone == 'local':
 
274
        tt = time.localtime(t)
 
275
        offset = local_time_offset(t)
 
276
    else:
 
277
        bailout("unsupported timezone format %r",
 
278
                ['options are "utc", "original", "local"'])
 
279
 
 
280
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
281
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
282
 
 
283
 
 
284
def compact_date(when):
 
285
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
286
    
 
287
 
 
288
 
 
289
def filesize(f):
 
290
    """Return size of given open file."""
 
291
    return os.fstat(f.fileno())[ST_SIZE]
 
292
 
 
293
 
 
294
if hasattr(os, 'urandom'): # python 2.4 and later
 
295
    rand_bytes = os.urandom
 
296
else:
 
297
    # FIXME: No good on non-Linux
 
298
    _rand_file = file('/dev/urandom', 'rb')
 
299
    rand_bytes = _rand_file.read
 
300
 
 
301
 
 
302
## TODO: We could later have path objects that remember their list
 
303
## decomposition (might be too tricksy though.)
 
304
 
 
305
def splitpath(p):
 
306
    """Turn string into list of parts.
 
307
 
 
308
    >>> splitpath('a')
 
309
    ['a']
 
310
    >>> splitpath('a/b')
 
311
    ['a', 'b']
 
312
    >>> splitpath('a/./b')
 
313
    ['a', 'b']
 
314
    >>> splitpath('a/.b')
 
315
    ['a', '.b']
 
316
    >>> splitpath('a/../b')
 
317
    Traceback (most recent call last):
 
318
    ...
 
319
    BzrError: ("sorry, '..' not allowed in path", [])
 
320
    """
 
321
    assert isinstance(p, types.StringTypes)
 
322
 
 
323
    # split on either delimiter because people might use either on
 
324
    # Windows
 
325
    ps = re.split(r'[\\/]', p)
 
326
 
 
327
    rps = []
 
328
    for f in ps:
 
329
        if f == '..':
 
330
            bailout("sorry, %r not allowed in path" % f)
 
331
        elif (f == '.') or (f == ''):
 
332
            pass
 
333
        else:
 
334
            rps.append(f)
 
335
    return rps
 
336
 
 
337
def joinpath(p):
 
338
    assert isinstance(p, list)
 
339
    for f in p:
 
340
        if (f == '..') or (f == None) or (f == ''):
 
341
            bailout("sorry, %r not allowed in path" % f)
 
342
    return os.path.join(*p)
 
343
 
 
344
 
 
345
def appendpath(p1, p2):
 
346
    if p1 == '':
 
347
        return p2
 
348
    else:
 
349
        return os.path.join(p1, p2)
 
350
    
 
351
 
 
352
def extern_command(cmd, ignore_errors = False):
 
353
    mutter('external command: %s' % `cmd`)
 
354
    if os.system(cmd):
 
355
        if not ignore_errors:
 
356
            bailout('command failed')
 
357