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
19
import os, types, re, time, errno
19
import os, types, re, time, errno, sys
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from errors import bailout, BzrError
23
from trace import mutter
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
26
26
def make_readonly(filename):
37
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
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)
44
"""Return a quoted filename filename
46
This previously used backslash quoting, but that works poorly on
48
# TODO: I'm not really sure this is the best format either.x
51
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
53
if _QUOTE_RE.search(f):
56
65
elif S_ISLNK(mode):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
68
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
71
def kind_marker(kind):
74
elif kind == 'directory':
76
elif kind == 'symlink':
79
raise BzrError('invalid file kind %r' % kind)
84
"""Copy a file to a backup.
86
Backups are named in GNU-style, with a ~ suffix.
88
If the file is already a backup, it's not copied.
101
outf = file(bfn, 'wb')
107
def rename(path_from, path_to):
108
"""Basically the same as os.rename() just special for win32"""
109
if sys.platform == 'win32':
113
if e.errno != e.ENOENT:
115
os.rename(path_from, path_to)
138
def is_inside(dir, fname):
139
"""True if fname is inside dir.
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.
145
The empty string as a dir name is taken as top-of-tree and matches
148
>>> is_inside('src', 'src/foo.c')
150
>>> is_inside('src', 'srccontrol')
152
>>> is_inside('src', 'src/a/a/a/foo.c')
154
>>> is_inside('foo.c', 'foo.c')
156
>>> is_inside('foo.c', '')
158
>>> is_inside('', 'foo.c')
161
# XXX: Most callers of this can actually do something smarter by
162
# looking at the inventory
169
if dir[-1] != os.sep:
172
return fname.startswith(dir)
175
def is_inside_any(dir_list, fname):
176
"""True if fname is inside any of given dirs."""
177
for dirname in dir_list:
178
if is_inside(dirname, fname):
80
184
def pumpfile(fromfile, tofile):
81
185
"""Copy contents of one file to another."""
82
186
tofile.write(fromfile.read())
86
190
"""Return a new UUID"""
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.
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
192
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
94
194
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
107
199
if hasattr(f, 'tell'):
108
200
assert f.tell() == 0
111
208
return s.hexdigest()
175
272
return realname, (username + '@' + socket.gethostname())
275
def _get_user_id(branch):
179
276
"""Return the full user id from a file or environment variable.
181
TODO: Allow taking this from a file in the branch directory too
182
for per-branch ids."""
278
e.g. "John Hacker <jhacker@foo.org>"
281
A branch to use for a per-branch configuration, or None.
283
The following are searched in order:
286
2. .bzr/email for this branch.
183
290
v = os.environ.get('BZREMAIL')
185
292
return v.decode(bzrlib.user_encoding)
296
return (branch.controlfile("email", "r")
298
.decode(bzrlib.user_encoding)
301
if e.errno != errno.ENOENT:
188
307
return (open(os.path.join(config_dir(), "email"))
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
340
def user_email(branch):
223
341
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
226
m = _EMAIL_RE.search(e)
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
228
bailout("%r doesn't seem to contain a reasonable email address" % e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
229
347
return m.group(0)
231
349
return _auto_user_id()[1]
274
391
tt = time.localtime(t)
275
392
offset = local_time_offset(t)
277
bailout("unsupported timezone format %r",
278
['options are "utc", "original", "local"'])
394
raise BzrError("unsupported timezone format %r" % timezone,
395
['options are "utc", "original", "local"'])
280
397
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
281
398
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
294
411
if hasattr(os, 'urandom'): # python 2.4 and later
295
412
rand_bytes = os.urandom
413
elif sys.platform == 'linux2':
414
rand_bytes = file('/dev/urandom', 'rb').read
297
# FIXME: No good on non-Linux
298
_rand_file = file('/dev/urandom', 'rb')
299
rand_bytes = _rand_file.read
416
# not well seeded, but better than nothing
421
s += chr(random.randint(0, 255))
302
426
## TODO: We could later have path objects that remember their list
316
440
>>> splitpath('a/../b')
317
441
Traceback (most recent call last):
319
BzrError: ("sorry, '..' not allowed in path", [])
443
BzrError: sorry, '..' not allowed in path
321
445
assert isinstance(p, types.StringTypes)
353
477
mutter('external command: %s' % `cmd`)
354
478
if os.system(cmd):
355
479
if not ignore_errors:
356
bailout('command failed')
480
raise BzrError('command failed')
483
def _read_config_value(name):
484
"""Read a config value from the file ~/.bzr.conf/<name>
485
Return None if the file does not exist"""
487
f = file(os.path.join(config_dir(), name), "r")
488
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
490
if e.errno == errno.ENOENT:
496
"""Return a sequence of possible editor binaries for the current platform"""
497
e = _read_config_value("editor")
501
if os.name == "windows":
503
elif os.name == "posix":
505
yield os.environ["EDITOR"]
510
def _run_editor(filename):
511
"""Try to execute an editor to edit the commit message. Returns True on success,
513
for e in _get_editor():
514
x = os.spawnvp(os.P_WAIT, e, (e, filename))
521
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
525
def get_text_message(infotext, ignoreline = "default"):
528
if ignoreline == "default":
529
ignoreline = "-- This line and the following will be ignored --"
532
tmp_fileno, msgfilename = tempfile.mkstemp()
533
msgfile = os.close(tmp_fileno)
534
if infotext is not None and infotext != "":
536
msgfile = file(msgfilename, "w")
537
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
542
if not _run_editor(msgfilename):
547
lastline, nlines = 0, 0
548
for line in file(msgfilename, "r"):
549
stripped_line = line.strip()
550
# strip empty line before the log message starts
552
if stripped_line != "":
556
# check for the ignore line only if there
557
# is additional information at the end
558
if hasinfo and stripped_line == ignoreline:
561
# keep track of the last line that had some content
562
if stripped_line != "":
568
# delete empty lines at the end
570
# add a newline at the end, if needed
571
if not msg[-1].endswith("\n"):
572
return "%s%s" % ("".join(msg), "\n")
576
# delete the msg file in any case
577
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
