← 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-06-24 05:34:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050624053425-6fab66f10cf619f4
- log messages from a particular test are printed if that test fails

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
 
19
import os, types, re, time, errno, sys
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
 
22
from bzrlib.errors import BzrError
 
23
from bzrlib.trace import mutter
 
24
import bzrlib
24
25
 
25
26
def make_readonly(filename):
26
27
    """Make a filename read-only."""
55
56
    elif S_ISLNK(mode):
56
57
        return 'symlink'
57
58
    else:
58
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
 
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)
59
71
 
60
72
 
61
73
 
76
88
        return False
77
89
 
78
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
 
79
110
def pumpfile(fromfile, tofile):
80
111
    """Copy contents of one file to another."""
81
112
    tofile.write(fromfile.read())
83
114
 
84
115
def uuid():
85
116
    """Return a new UUID"""
86
 
    
87
 
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
88
 
    ## Linux, but we need something portable for other systems;
89
 
    ## preferably an implementation in Python.
90
117
    try:
91
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
118
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
92
119
    except IOError:
93
120
        return chomp(os.popen('uuidgen').readline())
94
121
 
95
122
 
96
 
def chomp(s):
97
 
    if s and (s[-1] == '\n'):
98
 
        return s[:-1]
99
 
    else:
100
 
        return s
101
 
 
102
 
 
103
123
def sha_file(f):
104
124
    import sha
105
 
    ## TODO: Maybe read in chunks to handle big files
106
125
    if hasattr(f, 'tell'):
107
126
        assert f.tell() == 0
108
127
    s = sha.new()
109
 
    s.update(f.read())
 
128
    BUFSIZE = 128<<10
 
129
    while True:
 
130
        b = f.read(BUFSIZE)
 
131
        if not b:
 
132
            break
 
133
        s.update(b)
110
134
    return s.hexdigest()
111
135
 
112
136
 
128
152
            'sha1': s.hexdigest()}
129
153
 
130
154
 
131
 
 
132
 
def username():
133
 
    """Return email-style username.
134
 
 
135
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
136
 
 
137
 
    :todo: Check it's reasonably well-formed.
138
 
 
139
 
    :todo: Allow taking it from a dotfile to help people on windows
140
 
           who can't easily set variables.
141
 
 
142
 
    :todo: Cope without pwd module, which is only on unix. 
143
 
    """
144
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
145
 
    if e: return e
146
 
 
 
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
    """
147
176
    import socket
148
 
    
 
177
 
 
178
    # XXX: Any good way to get real user name on win32?
 
179
 
149
180
    try:
150
181
        import pwd
151
182
        uid = os.getuid()
152
183
        w = pwd.getpwuid(uid)
153
 
        gecos = w.pw_gecos
 
184
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
 
185
        username = w.pw_name.decode(bzrlib.user_encoding)
154
186
        comma = gecos.find(',')
155
187
        if comma == -1:
156
188
            realname = gecos
157
189
        else:
158
190
            realname = gecos[:comma]
159
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
191
        if not realname:
 
192
            realname = username
 
193
 
160
194
    except ImportError:
161
 
        pass
162
 
 
163
 
    import getpass, socket
164
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
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
165
242
 
166
243
 
167
244
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
168
245
def user_email():
169
246
    """Return just the email component of a username."""
170
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
247
    e = _get_user_id()
171
248
    if e:
172
249
        m = _EMAIL_RE.search(e)
173
250
        if not m:
174
 
            bailout('%r is not a reasonable email address' % e)
 
251
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
175
252
        return m.group(0)
176
253
 
177
 
 
178
 
    import getpass, socket
179
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
180
 
 
 
254
    return _auto_user_id()[1]
181
255
    
182
256
 
183
257
 
184
258
def compare_files(a, b):
185
259
    """Returns true if equal in contents"""
186
 
    # TODO: don't read the whole thing in one go.
187
260
    BUFSIZE = 4096
188
261
    while True:
189
262
        ai = a.read(BUFSIZE)
223
296
        tt = time.localtime(t)
224
297
        offset = local_time_offset(t)
225
298
    else:
226
 
        bailout("unsupported timezone format %r",
 
299
        raise BzrError("unsupported timezone format %r",
227
300
                ['options are "utc", "original", "local"'])
228
301
 
229
302
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
242
315
 
243
316
if hasattr(os, 'urandom'): # python 2.4 and later
244
317
    rand_bytes = os.urandom
 
318
elif sys.platform == 'linux2':
 
319
    rand_bytes = file('/dev/urandom', 'rb').read
245
320
else:
246
 
    # FIXME: No good on non-Linux
247
 
    _rand_file = file('/dev/urandom', 'rb')
248
 
    rand_bytes = _rand_file.read
 
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
249
329
 
250
330
 
251
331
## TODO: We could later have path objects that remember their list
265
345
    >>> splitpath('a/../b')
266
346
    Traceback (most recent call last):
267
347
    ...
268
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
348
    BzrError: sorry, '..' not allowed in path
269
349
    """
270
350
    assert isinstance(p, types.StringTypes)
271
 
    ps = [f for f in p.split('/') if (f != '.' and f != '')]
 
351
 
 
352
    # split on either delimiter because people might use either on
 
353
    # Windows
 
354
    ps = re.split(r'[\\/]', p)
 
355
 
 
356
    rps = []
272
357
    for f in ps:
273
358
        if f == '..':
274
 
            bailout("sorry, %r not allowed in path" % f)
275
 
    return ps
 
359
            raise BzrError("sorry, %r not allowed in path" % f)
 
360
        elif (f == '.') or (f == ''):
 
361
            pass
 
362
        else:
 
363
            rps.append(f)
 
364
    return rps
276
365
 
277
366
def joinpath(p):
278
367
    assert isinstance(p, list)
279
368
    for f in p:
280
369
        if (f == '..') or (f == None) or (f == ''):
281
 
            bailout("sorry, %r not allowed in path" % f)
282
 
    return '/'.join(p)
 
370
            raise BzrError("sorry, %r not allowed in path" % f)
 
371
    return os.path.join(*p)
283
372
 
284
373
 
285
374
def appendpath(p1, p2):
286
375
    if p1 == '':
287
376
        return p2
288
377
    else:
289
 
        return p1 + '/' + p2
 
378
        return os.path.join(p1, p2)
290
379
    
291
380
 
292
381
def extern_command(cmd, ignore_errors = False):
293
382
    mutter('external command: %s' % `cmd`)
294
383
    if os.system(cmd):
295
384
        if not ignore_errors:
296
 
            bailout('command failed')
297
 
 
 
385
            raise BzrError('command failed')
 
386
 
 
387
 
 
388
def _read_config_value(name):
 
389
    """Read a config value from the file ~/.bzr.conf/<name>
 
390
    Return None if the file does not exist"""
 
391
    try:
 
392
        f = file(os.path.join(config_dir(), name), "r")
 
393
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
 
394
    except IOError, e:
 
395
        if e.errno == errno.ENOENT:
 
396
            return None
 
397
        raise
 
398
 
 
399
 
 
400
def _get_editor():
 
401
    """Return a sequence of possible editor binaries for the current platform"""
 
402
    e = _read_config_value("editor")
 
403
    if e is not None:
 
404
        yield e
 
405
        
 
406
    if os.name == "windows":
 
407
        yield "notepad.exe"
 
408
    elif os.name == "posix":
 
409
        try:
 
410
            yield os.environ["EDITOR"]
 
411
        except KeyError:
 
412
            yield "/usr/bin/vi"
 
413
 
 
414
 
 
415
def _run_editor(filename):
 
416
    """Try to execute an editor to edit the commit message. Returns True on success,
 
417
    False on failure"""
 
418
    for e in _get_editor():
 
419
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
 
420
        if x == 0:
 
421
            return True
 
422
        elif x == 127:
 
423
            continue
 
424
        else:
 
425
            break
 
426
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
 
427
    return False
 
428
                          
 
429
 
 
430
def get_text_message(infotext, ignoreline = "default"):
 
431
    import tempfile
 
432
    
 
433
    if ignoreline == "default":
 
434
        ignoreline = "-- This line and the following will be ignored --"
 
435
        
 
436
    try:
 
437
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
438
        msgfile = os.close(tmp_fileno)
 
439
        if infotext is not None and infotext != "":
 
440
            hasinfo = True
 
441
            msgfile = file(msgfilename, "w")
 
442
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
443
            msgfile.close()
 
444
        else:
 
445
            hasinfo = False
 
446
 
 
447
        if not _run_editor(msgfilename):
 
448
            return None
 
449
        
 
450
        started = False
 
451
        msg = []
 
452
        lastline, nlines = 0, 0
 
453
        for line in file(msgfilename, "r"):
 
454
            stripped_line = line.strip()
 
455
            # strip empty line before the log message starts
 
456
            if not started:
 
457
                if stripped_line != "":
 
458
                    started = True
 
459
                else:
 
460
                    continue
 
461
            # check for the ignore line only if there
 
462
            # is additional information at the end
 
463
            if hasinfo and stripped_line == ignoreline:
 
464
                break
 
465
            nlines += 1
 
466
            # keep track of the last line that had some content
 
467
            if stripped_line != "":
 
468
                lastline = nlines
 
469
            msg.append(line)
 
470
            
 
471
        if len(msg) == 0:
 
472
            return None
 
473
        # delete empty lines at the end
 
474
        del msg[lastline:]
 
475
        # add a newline at the end, if needed
 
476
        if not msg[-1].endswith("\n"):
 
477
            return "%s%s" % ("".join(msg), "\n")
 
478
        else:
 
479
            return "".join(msg)
 
480
    finally:
 
481
        # delete the msg file in any case
 
482
        try: os.unlink(msgfilename)
 
483
        except IOError: pass