← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
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
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
19
import os, types, re, time, types
 
20
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
21
21
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
24
 
import bzrlib
 
22
from errors import bailout
25
23
 
26
24
def make_readonly(filename):
27
25
    """Make a filename read-only."""
53
51
        return 'file'
54
52
    elif S_ISDIR(mode):
55
53
        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)
 
54
    else:
 
55
        bailout("can't handle file kind of %r" % fp)
71
56
 
72
57
 
73
58
 
88
73
        return False
89
74
 
90
75
 
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
76
def pumpfile(fromfile, tofile):
111
77
    """Copy contents of one file to another."""
112
78
    tofile.write(fromfile.read())
114
80
 
115
81
def uuid():
116
82
    """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())
 
83
    
 
84
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
85
    ## Linux, but we need something portable for other systems;
 
86
    ## preferably an implementation in Python.
 
87
    bailout('uuids not allowed!')
 
88
    return chomp(os.popen('uuidgen').readline())
 
89
 
 
90
def chomp(s):
 
91
    if s and (s[-1] == '\n'):
 
92
        return s[:-1]
 
93
    else:
 
94
        return s
121
95
 
122
96
 
123
97
def sha_file(f):
124
98
    import sha
 
99
    ## TODO: Maybe read in chunks to handle big files
125
100
    if hasattr(f, 'tell'):
126
101
        assert f.tell() == 0
127
102
    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)
 
103
    s.update(f.read())
134
104
    return s.hexdigest()
135
105
 
136
106
 
142
112
 
143
113
 
144
114
 
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
 
    """
 
115
def username():
 
116
    """Return email-style username.
 
117
 
 
118
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
119
 
 
120
    :todo: Check it's reasonably well-formed.
 
121
 
 
122
    :todo: Allow taking it from a dotfile to help people on windows
 
123
           who can't easily set variables.
 
124
 
 
125
    :todo: Cope without pwd module, which is only on unix. 
 
126
    """
 
127
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
128
    if e: return e
 
129
 
176
130
    import socket
177
 
 
178
 
    # XXX: Any good way to get real user name on win32?
179
 
 
 
131
    
180
132
    try:
181
133
        import pwd
182
134
        uid = os.getuid()
183
135
        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
 
 
 
136
        realname, junk = w.pw_gecos.split(',', 1)
 
137
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
194
138
    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+.-]+')
 
139
        pass
 
140
 
 
141
    import getpass, socket
 
142
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
143
 
 
144
 
245
145
def user_email():
246
146
    """Return just the email component of a username."""
247
 
    e = _get_user_id()
 
147
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
248
148
    if e:
249
 
        m = _EMAIL_RE.search(e)
 
149
        import re
 
150
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
250
151
        if not m:
251
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
152
            bailout('%r is not a reasonable email address' % e)
252
153
        return m.group(0)
253
154
 
254
 
    return _auto_user_id()[1]
 
155
 
 
156
    import getpass, socket
 
157
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
158
 
255
159
    
256
160
 
257
161
 
258
162
def compare_files(a, b):
259
163
    """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'):
 
164
    # TODO: don't read the whole thing in one go.
 
165
    result = a.read() == b.read()
 
166
    return result
 
167
 
 
168
 
 
169
 
 
170
def format_date(t, inutc=False):
284
171
    ## TODO: Perhaps a global option to use either universal or local time?
285
172
    ## Or perhaps just let people set $TZ?
 
173
    import time
 
174
    
286
175
    assert isinstance(t, float)
287
176
    
288
 
    if timezone == 'utc':
 
177
    if inutc:
289
178
        tt = time.gmtime(t)
 
179
        zonename = 'UTC'
290
180
        offset = 0
291
 
    elif timezone == 'original':
292
 
        if offset == None:
293
 
            offset = 0
294
 
        tt = time.gmtime(t + offset)
295
 
    elif timezone == 'local':
 
181
    else:
296
182
        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
 
 
 
183
        if time.daylight:
 
184
            zonename = time.tzname[1]
 
185
            offset = - time.altzone
 
186
        else:
 
187
            zonename = time.tzname[0]
 
188
            offset = - time.timezone
 
189
            
302
190
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
303
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
191
            + ' ' + zonename + ' '
 
192
            + '%+03d%02d' % (offset / 3600, (offset / 60) % 60))
304
193
 
305
194
 
306
195
def compact_date(when):
315
204
 
316
205
if hasattr(os, 'urandom'): # python 2.4 and later
317
206
    rand_bytes = os.urandom
318
 
elif sys.platform == 'linux2':
319
 
    rand_bytes = file('/dev/urandom', 'rb').read
320
207
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
 
208
    # FIXME: No good on non-Linux
 
209
    _rand_file = file('/dev/urandom', 'rb')
 
210
    rand_bytes = _rand_file.read
329
211
 
330
212
 
331
213
## TODO: We could later have path objects that remember their list
348
230
    BzrError: ("sorry, '..' not allowed in path", [])
349
231
    """
350
232
    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 = []
 
233
    ps = [f for f in p.split('/') if f != '.']
357
234
    for f in ps:
358
235
        if f == '..':
359
236
            bailout("sorry, %r not allowed in path" % f)
360
 
        elif (f == '.') or (f == ''):
361
 
            pass
362
 
        else:
363
 
            rps.append(f)
364
 
    return rps
 
237
    return ps
365
238
 
366
239
def joinpath(p):
367
240
    assert isinstance(p, list)
368
241
    for f in p:
369
 
        if (f == '..') or (f == None) or (f == ''):
 
242
        if (f == '..') or (f is None) or (f == ''):
370
243
            bailout("sorry, %r not allowed in path" % f)
371
 
    return os.path.join(*p)
 
244
    return '/'.join(p)
372
245
 
373
246
 
374
247
def appendpath(p1, p2):
375
248
    if p1 == '':
376
249
        return p2
377
250
    else:
378
 
        return os.path.join(p1, p2)
 
251
        return p1 + '/' + p2
379
252
    
380
253
 
381
254
def extern_command(cmd, ignore_errors = False):