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())
190
84
"""Return a new UUID"""
86
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
87
## Linux, but we need something portable for other systems;
88
## preferably an implementation in Python.
192
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
90
return chomp(file('/proc/sys/kernel/random/uuid').readline())
194
92
return chomp(os.popen('uuidgen').readline())
96
if s and (s[-1] == '\n'):
104
## TODO: Maybe read in chunks to handle big files
199
105
if hasattr(f, 'tell'):
200
106
assert f.tell() == 0
208
109
return s.hexdigest()
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
121
"""Return email-style username.
123
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
125
:todo: Check it's reasonably well-formed.
127
:todo: Allow taking it from a dotfile to help people on windows
128
who can't easily set variables.
130
:todo: Cope without pwd module, which is only on unix.
132
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
252
# XXX: Any good way to get real user name on win32?
256
139
uid = os.getuid()
257
140
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
260
142
comma = gecos.find(',')
264
146
realname = gecos[:comma]
147
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
268
148
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):
151
import getpass, socket
152
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
341
156
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
157
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
344
160
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
162
bailout('%r is not a reasonable email address' % e)
347
163
return m.group(0)
349
return _auto_user_id()[1]
166
import getpass, socket
167
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
353
172
def compare_files(a, b):
354
173
"""Returns true if equal in contents"""
174
# TODO: don't read the whole thing in one go.
357
177
ai = a.read(BUFSIZE)
391
213
tt = time.localtime(t)
392
214
offset = local_time_offset(t)
394
raise BzrError("unsupported timezone format %r" % timezone,
395
['options are "utc", "original", "local"'])
216
bailout("unsupported timezone format %r",
217
['options are "utc", "original", "local"'])
397
219
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
220
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
407
229
"""Return size of given open file."""
408
230
return os.fstat(f.fileno())[ST_SIZE]
410
# Define rand_bytes based on platform.
412
# Python 2.4 and later have os.urandom,
413
# but it doesn't work on some arches
233
if hasattr(os, 'urandom'): # python 2.4 and later
415
234
rand_bytes = os.urandom
416
except (NotImplementedError, AttributeError):
417
# If python doesn't have os.urandom, or it doesn't work,
418
# then try to first pull random data from /dev/urandom
419
if os.path.exists("/dev/urandom"):
420
rand_bytes = file('/dev/urandom', 'rb').read
421
# Otherwise, use this hack as a last resort
423
# not well seeded, but better than nothing
428
s += chr(random.randint(0, 255))
236
# FIXME: No good on non-Linux
237
_rand_file = file('/dev/urandom', 'rb')
238
rand_bytes = _rand_file.read
432
241
## TODO: We could later have path objects that remember their list
433
242
## decomposition (might be too tricksy though.)
446
255
>>> splitpath('a/../b')
447
256
Traceback (most recent call last):
449
BzrError: sorry, '..' not allowed in path
258
BzrError: ("sorry, '..' not allowed in path", [])
451
260
assert isinstance(p, types.StringTypes)
453
# split on either delimiter because people might use either on
455
ps = re.split(r'[\\/]', p)
261
ps = [f for f in p.split('/') if f != '.']
460
raise BzrError("sorry, %r not allowed in path" % f)
461
elif (f == '.') or (f == ''):
264
bailout("sorry, %r not allowed in path" % f)
468
268
assert isinstance(p, list)
470
if (f == '..') or (f == None) or (f == ''):
471
raise BzrError("sorry, %r not allowed in path" % f)
472
return os.path.join(*p)
270
if (f == '..') or (f is None) or (f == ''):
271
bailout("sorry, %r not allowed in path" % f)
475
275
def appendpath(p1, p2):
479
return os.path.join(p1, p2)
482
282
def extern_command(cmd, ignore_errors = False):
483
283
mutter('external command: %s' % `cmd`)
484
284
if os.system(cmd):
485
285
if not ignore_errors:
486
raise BzrError('command failed')
489
def _read_config_value(name):
490
"""Read a config value from the file ~/.bzr.conf/<name>
491
Return None if the file does not exist"""
493
f = file(os.path.join(config_dir(), name), "r")
494
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
496
if e.errno == errno.ENOENT:
286
bailout('command failed')
added
removed
bzrlib/osutils.py
