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