← 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-07-07 10:22:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
37
37
    os.chmod(filename, mod)
38
38
 
39
39
 
40
 
_QUOTE_RE = None
41
 
 
42
 
 
 
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
43
41
def quotefn(f):
44
42
    """Return a quoted filename filename
45
43
 
46
44
    This previously used backslash quoting, but that works poorly on
47
45
    Windows."""
48
46
    # TODO: I'm not really sure this is the best format either.x
49
 
    global _QUOTE_RE
50
 
    if _QUOTE_RE == None:
51
 
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
52
 
        
53
47
    if _QUOTE_RE.search(f):
54
48
        return '"' + f + '"'
55
49
    else:
104
98
    finally:
105
99
        outf.close()
106
100
 
107
 
def rename(path_from, path_to):
108
 
    """Basically the same as os.rename() just special for win32"""
109
 
    if sys.platform == 'win32':
110
 
        try:
111
 
            os.remove(path_to)
112
 
        except OSError, e:
113
 
            if e.errno != e.ENOENT:
114
 
                raise
115
 
    os.rename(path_from, path_to)
116
 
 
117
 
 
118
101
 
119
102
 
120
103
 
137
120
 
138
121
def is_inside(dir, fname):
139
122
    """True if fname is inside dir.
140
 
    
141
 
    The parameters should typically be passed to os.path.normpath first, so
142
 
    that . and .. and repeated slashes are eliminated, and the separators
143
 
    are canonical for the platform.
144
 
    
145
 
    The empty string as a dir name is taken as top-of-tree and matches 
146
 
    everything.
147
 
    
148
 
    >>> is_inside('src', 'src/foo.c')
149
 
    True
150
 
    >>> is_inside('src', 'srccontrol')
151
 
    False
152
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
153
 
    True
154
 
    >>> is_inside('foo.c', 'foo.c')
155
 
    True
156
 
    >>> is_inside('foo.c', '')
157
 
    False
158
 
    >>> is_inside('', 'foo.c')
159
 
    True
160
123
    """
161
 
    # XXX: Most callers of this can actually do something smarter by 
162
 
    # looking at the inventory
163
 
    if dir == fname:
164
 
        return True
165
 
    
166
 
    if dir == '':
167
 
        return True
168
 
    
169
 
    if dir[-1] != os.sep:
170
 
        dir += os.sep
171
 
    
172
 
    return fname.startswith(dir)
 
124
    return os.path.commonprefix([dir, fname]) == dir
173
125
 
174
126
 
175
127
def is_inside_any(dir_list, fname):
176
128
    """True if fname is inside any of given dirs."""
 
129
    # quick scan for perfect match
 
130
    if fname in dir_list:
 
131
        return True
 
132
    
177
133
    for dirname in dir_list:
178
134
        if is_inside(dirname, fname):
179
135
            return True
272
228
    return realname, (username + '@' + socket.gethostname())
273
229
 
274
230
 
275
 
def _get_user_id(branch):
 
231
def _get_user_id():
276
232
    """Return the full user id from a file or environment variable.
277
233
 
278
 
    e.g. "John Hacker <jhacker@foo.org>"
279
 
 
280
 
    branch
281
 
        A branch to use for a per-branch configuration, or None.
282
 
 
283
 
    The following are searched in order:
284
 
 
285
 
    1. $BZREMAIL
286
 
    2. .bzr/email for this branch.
287
 
    3. ~/.bzr.conf/email
288
 
    4. $EMAIL
289
 
    """
 
234
    TODO: Allow taking this from a file in the branch directory too
 
235
    for per-branch ids."""
290
236
    v = os.environ.get('BZREMAIL')
291
237
    if v:
292
238
        return v.decode(bzrlib.user_encoding)
293
 
 
294
 
    if branch:
295
 
        try:
296
 
            return (branch.controlfile("email", "r") 
297
 
                    .read()
298
 
                    .decode(bzrlib.user_encoding)
299
 
                    .rstrip("\r\n"))
300
 
        except IOError, e:
301
 
            if e.errno != errno.ENOENT:
302
 
                raise
303
 
        except BzrError, e:
304
 
            pass
305
239
    
306
240
    try:
307
241
        return (open(os.path.join(config_dir(), "email"))
319
253
        return None
320
254
 
321
255
 
322
 
def username(branch):
 
256
def username():
323
257
    """Return email-style username.
324
258
 
325
259
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
326
260
 
327
261
    TODO: Check it's reasonably well-formed.
328
262
    """
329
 
    v = _get_user_id(branch)
 
263
    v = _get_user_id()
330
264
    if v:
331
265
        return v
332
266
    
337
271
        return email
338
272
 
339
273
 
340
 
def user_email(branch):
 
274
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
275
def user_email():
341
276
    """Return just the email component of a username."""
342
 
    e = _get_user_id(branch)
 
277
    e = _get_user_id()
343
278
    if e:
344
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
279
        m = _EMAIL_RE.search(e)
345
280
        if not m:
346
281
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
347
282
        return m.group(0)
391
326
        tt = time.localtime(t)
392
327
        offset = local_time_offset(t)
393
328
    else:
394
 
        raise BzrError("unsupported timezone format %r" % timezone,
395
 
                       ['options are "utc", "original", "local"'])
 
329
        raise BzrError("unsupported timezone format %r",
 
330
                ['options are "utc", "original", "local"'])
396
331
 
397
332
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
333
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
492
427
        raise
493
428
 
494
429
 
 
430
def _get_editor():
 
431
    """Return a sequence of possible editor binaries for the current platform"""
 
432
    e = _read_config_value("editor")
 
433
    if e is not None:
 
434
        yield e
 
435
        
 
436
    if os.name == "windows":
 
437
        yield "notepad.exe"
 
438
    elif os.name == "posix":
 
439
        try:
 
440
            yield os.environ["EDITOR"]
 
441
        except KeyError:
 
442
            yield "/usr/bin/vi"
 
443
 
 
444
 
 
445
def _run_editor(filename):
 
446
    """Try to execute an editor to edit the commit message. Returns True on success,
 
447
    False on failure"""
 
448
    for e in _get_editor():
 
449
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
 
450
        if x == 0:
 
451
            return True
 
452
        elif x == 127:
 
453
            continue
 
454
        else:
 
455
            break
 
456
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
 
457
    return False
 
458
                          
 
459
 
 
460
def get_text_message(infotext, ignoreline = "default"):
 
461
    import tempfile
 
462
    
 
463
    if ignoreline == "default":
 
464
        ignoreline = "-- This line and the following will be ignored --"
 
465
        
 
466
    try:
 
467
        tmp_fileno, msgfilename = tempfile.mkstemp()
 
468
        msgfile = os.close(tmp_fileno)
 
469
        if infotext is not None and infotext != "":
 
470
            hasinfo = True
 
471
            msgfile = file(msgfilename, "w")
 
472
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
 
473
            msgfile.close()
 
474
        else:
 
475
            hasinfo = False
 
476
 
 
477
        if not _run_editor(msgfilename):
 
478
            return None
 
479
        
 
480
        started = False
 
481
        msg = []
 
482
        lastline, nlines = 0, 0
 
483
        for line in file(msgfilename, "r"):
 
484
            stripped_line = line.strip()
 
485
            # strip empty line before the log message starts
 
486
            if not started:
 
487
                if stripped_line != "":
 
488
                    started = True
 
489
                else:
 
490
                    continue
 
491
            # check for the ignore line only if there
 
492
            # is additional information at the end
 
493
            if hasinfo and stripped_line == ignoreline:
 
494
                break
 
495
            nlines += 1
 
496
            # keep track of the last line that had some content
 
497
            if stripped_line != "":
 
498
                lastline = nlines
 
499
            msg.append(line)
 
500
            
 
501
        if len(msg) == 0:
 
502
            return None
 
503
        # delete empty lines at the end
 
504
        del msg[lastline:]
 
505
        # add a newline at the end, if needed
 
506
        if not msg[-1].endswith("\n"):
 
507
            return "%s%s" % ("".join(msg), "\n")
 
508
        else:
 
509
            return "".join(msg)
 
510
    finally:
 
511
        # delete the msg file in any case
 
512
        try: os.unlink(msgfilename)
 
513
        except IOError: pass