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, types
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
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
24
26
def make_readonly(filename):
25
27
"""Make a filename read-only."""
35
37
os.chmod(filename, mod)
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
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)
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):
54
65
elif S_ISLNK(mode):
57
bailout("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):
78
184
def pumpfile(fromfile, tofile):
79
185
"""Copy contents of one file to another."""
80
186
tofile.write(fromfile.read())
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')
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
252
# XXX: Any good way to get real user name on win32?
136
256
uid = os.getuid()
137
257
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
139
260
comma = gecos.find(',')
143
264
realname = gecos[:comma]
144
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
145
268
except ImportError:
148
import getpass, socket
149
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
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):
153
341
"""Return just the email component of a username."""
154
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
342
e = _get_user_id(branch)
157
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
159
bailout('%r is not a reasonable email address' % e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
160
347
return m.group(0)
163
import getpass, socket
164
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
349
return _auto_user_id()[1]
169
353
def compare_files(a, b):
170
354
"""Returns true if equal in contents"""
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
177
366
def local_time_offset(t=None):
178
367
"""Return offset of local zone from GMT, either at present or at time t."""
368
# python2.3 localtime() can't take None
179
372
if time.localtime(t).tm_isdst and time.daylight:
180
373
return -time.altzone
200
391
tt = time.localtime(t)
201
392
offset = local_time_offset(t)
203
bailout("unsupported timezone format %r",
204
['options are "utc", "original", "local"'])
394
raise BzrError("unsupported timezone format %r" % timezone,
395
['options are "utc", "original", "local"'])
206
397
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
207
398
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
220
411
if hasattr(os, 'urandom'): # python 2.4 and later
221
412
rand_bytes = os.urandom
413
elif sys.platform == 'linux2':
414
rand_bytes = file('/dev/urandom', 'rb').read
223
# FIXME: No good on non-Linux
224
_rand_file = file('/dev/urandom', 'rb')
225
rand_bytes = _rand_file.read
416
# not well seeded, but better than nothing
421
s += chr(random.randint(0, 255))
228
426
## TODO: We could later have path objects that remember their list
242
440
>>> splitpath('a/../b')
243
441
Traceback (most recent call last):
245
BzrError: ("sorry, '..' not allowed in path", [])
443
BzrError: sorry, '..' not allowed in path
247
445
assert isinstance(p, types.StringTypes)
248
ps = [f for f in p.split('/') if f != '.']
447
# split on either delimiter because people might use either on
449
ps = re.split(r'[\\/]', p)
251
bailout("sorry, %r not allowed in path" % f)
454
raise BzrError("sorry, %r not allowed in path" % f)
455
elif (f == '.') or (f == ''):
255
462
assert isinstance(p, list)
257
if (f == '..') or (f is None) or (f == ''):
258
bailout("sorry, %r not allowed in path" % f)
464
if (f == '..') or (f == None) or (f == ''):
465
raise BzrError("sorry, %r not allowed in path" % f)
466
return os.path.join(*p)
262
469
def appendpath(p1, p2):
473
return os.path.join(p1, p2)
269
476
def extern_command(cmd, ignore_errors = False):
270
477
mutter('external command: %s' % `cmd`)
271
478
if os.system(cmd):
272
479
if not ignore_errors:
273
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: