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, errno
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, BzrError
23
from 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.,:/_~-])')
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):
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)
65
56
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)
59
raise BzrError("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
80
def pumpfile(fromfile, tofile):
185
81
"""Copy contents of one file to another."""
186
82
tofile.write(fromfile.read())
190
86
"""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.
192
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
194
94
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
199
107
if hasattr(f, 'tell'):
200
108
assert f.tell() == 0
208
111
return s.hexdigest()
226
129
'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")
239
132
def _auto_user_id():
240
133
"""Calculate automatic user identification.
264
157
realname = gecos[:comma]
268
159
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.
162
username = getpass.getuser().decode(bzrlib.user_encoding)
164
return realname, (username + '@' + os.gethostname())
290
168
v = os.environ.get('BZREMAIL')
292
170
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"))
173
return (open(os.path.expanduser("~/.bzr.email"))
309
175
.decode(bzrlib.user_encoding)
312
if e.errno != errno.ENOENT:
178
if e.errno != ENOENT:
315
181
v = os.environ.get('EMAIL')
322
def username(branch):
323
189
"""Return email-style username.
325
191
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
327
193
TODO: Check it's reasonably well-formed.
195
TODO: Allow taking it from a dotfile to help people on windows
196
who can't easily set variables.
329
v = _get_user_id(branch)
340
def user_email(branch):
209
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
341
211
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
214
m = _EMAIL_RE.search(e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
216
bailout("%r doesn't seem to contain a reasonable email address" % e)
347
217
return m.group(0)
349
219
return _auto_user_id()[1]
391
262
tt = time.localtime(t)
392
263
offset = local_time_offset(t)
394
raise BzrError("unsupported timezone format %r" % timezone,
395
['options are "utc", "original", "local"'])
265
bailout("unsupported timezone format %r",
266
['options are "utc", "original", "local"'])
397
268
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
269
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
411
282
if hasattr(os, 'urandom'): # python 2.4 and later
412
283
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))
285
# FIXME: No good on non-Linux
286
_rand_file = file('/dev/urandom', 'rb')
287
rand_bytes = _rand_file.read
426
290
## TODO: We could later have path objects that remember their list
440
304
>>> splitpath('a/../b')
441
305
Traceback (most recent call last):
443
BzrError: sorry, '..' not allowed in path
307
BzrError: ("sorry, '..' not allowed in path", [])
445
309
assert isinstance(p, types.StringTypes)
447
# split on either delimiter because people might use either on
449
ps = re.split(r'[\\/]', p)
310
ps = [f for f in p.split('/') if (f != '.' and f != '')]
454
raise BzrError("sorry, %r not allowed in path" % f)
455
elif (f == '.') or (f == ''):
313
bailout("sorry, %r not allowed in path" % f)
462
317
assert isinstance(p, list)
464
319
if (f == '..') or (f == None) or (f == ''):
465
raise BzrError("sorry, %r not allowed in path" % f)
466
return os.path.join(*p)
320
bailout("sorry, %r not allowed in path" % f)
469
324
def appendpath(p1, p2):
473
return os.path.join(p1, p2)
476
331
def extern_command(cmd, ignore_errors = False):
477
332
mutter('external command: %s' % `cmd`)
478
333
if os.system(cmd):
479
334
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:
335
bailout('command failed')
added
removed
bzrlib/osutils.py
