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, sys
19
import os, types, re, time, types
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
22
from errors import bailout
26
24
def make_readonly(filename):
27
25
"""Make a filename read-only."""
37
35
os.chmod(filename, mod)
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
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):
40
"""Return shell-quoted filename"""
41
## We could be a bit more terse by using double-quotes etc
42
f = _QUOTE_RE.sub(r'\\\1', f)
65
54
elif S_ISLNK(mode):
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)
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
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):
184
78
def pumpfile(fromfile, tofile):
185
79
"""Copy contents of one file to another."""
186
80
tofile.write(fromfile.read())
219
def fingerprint_file(f):
225
return {'size': size,
226
'sha1': s.hexdigest()}
230
"""Return per-user configuration directory.
232
By default this is ~/.bzr.conf/
234
TODO: Global option --config-dir to override this.
236
return os.path.expanduser("~/.bzr.conf")
240
"""Calculate automatic user identification.
242
Returns (realname, email).
244
Only used when none is set in the environment or the id file.
246
This previously used the FQDN as the default domain, but that can
247
be very slow on machines where DNS is broken. So now we simply
118
"""Return email-style username.
120
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
122
:todo: Check it's reasonably well-formed.
124
:todo: Allow taking it from a dotfile to help people on windows
125
who can't easily set variables.
127
:todo: Cope without pwd module, which is only on unix.
129
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
252
# XXX: Any good way to get real user name on win32?
256
136
uid = os.getuid()
257
137
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
260
139
comma = gecos.find(',')
264
143
realname = gecos[:comma]
144
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
268
145
except ImportError:
270
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
272
return realname, (username + '@' + socket.gethostname())
275
def _get_user_id(branch):
276
"""Return the full user id from a file or environment variable.
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.
290
v = os.environ.get('BZREMAIL')
292
return v.decode(bzrlib.user_encoding)
296
return (branch.controlfile("email", "r")
298
.decode(bzrlib.user_encoding)
301
if e.errno != errno.ENOENT:
307
return (open(os.path.join(config_dir(), "email"))
309
.decode(bzrlib.user_encoding)
312
if e.errno != errno.ENOENT:
315
v = os.environ.get('EMAIL')
317
return v.decode(bzrlib.user_encoding)
322
def username(branch):
323
"""Return email-style username.
325
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
327
TODO: Check it's reasonably well-formed.
329
v = _get_user_id(branch)
333
name, email = _auto_user_id()
335
return '%s <%s>' % (name, email)
340
def user_email(branch):
148
import getpass, socket
149
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
341
153
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
154
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
344
157
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
159
bailout('%r is not a reasonable email address' % e)
347
160
return m.group(0)
349
return _auto_user_id()[1]
163
import getpass, socket
164
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
353
169
def compare_files(a, b):
354
170
"""Returns true if equal in contents"""
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
366
177
def local_time_offset(t=None):
367
178
"""Return offset of local zone from GMT, either at present or at time t."""
368
# python2.3 localtime() can't take None
372
179
if time.localtime(t).tm_isdst and time.daylight:
373
180
return -time.altzone
391
200
tt = time.localtime(t)
392
201
offset = local_time_offset(t)
394
raise BzrError("unsupported timezone format %r" % timezone,
395
['options are "utc", "original", "local"'])
203
bailout("unsupported timezone format %r",
204
['options are "utc", "original", "local"'])
397
206
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
207
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
411
220
if hasattr(os, 'urandom'): # python 2.4 and later
412
221
rand_bytes = os.urandom
413
elif sys.platform == 'linux2':
414
rand_bytes = file('/dev/urandom', 'rb').read
416
# not well seeded, but better than nothing
421
s += chr(random.randint(0, 255))
223
# FIXME: No good on non-Linux
224
_rand_file = file('/dev/urandom', 'rb')
225
rand_bytes = _rand_file.read
426
228
## TODO: We could later have path objects that remember their list
440
242
>>> splitpath('a/../b')
441
243
Traceback (most recent call last):
443
BzrError: sorry, '..' not allowed in path
245
BzrError: ("sorry, '..' not allowed in path", [])
445
247
assert isinstance(p, types.StringTypes)
447
# split on either delimiter because people might use either on
449
ps = re.split(r'[\\/]', p)
248
ps = [f for f in p.split('/') if f != '.']
454
raise BzrError("sorry, %r not allowed in path" % f)
455
elif (f == '.') or (f == ''):
251
bailout("sorry, %r not allowed in path" % f)
462
255
assert isinstance(p, list)
464
if (f == '..') or (f == None) or (f == ''):
465
raise BzrError("sorry, %r not allowed in path" % f)
466
return os.path.join(*p)
257
if (f == '..') or (f is None) or (f == ''):
258
bailout("sorry, %r not allowed in path" % f)
469
262
def appendpath(p1, p2):
473
return os.path.join(p1, p2)
476
269
def extern_command(cmd, ignore_errors = False):
477
270
mutter('external command: %s' % `cmd`)
478
271
if os.system(cmd):
479
272
if not ignore_errors:
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)
273
bailout('command failed')
added
removed
bzrlib/osutils.py
