1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
20
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
30
from bzrlib.errors import BzrError
31
from bzrlib.trace import mutter
34
def make_readonly(filename):
35
"""Make a filename read-only."""
36
mod = os.stat(filename).st_mode
38
os.chmod(filename, mod)
41
def make_writable(filename):
42
mod = os.stat(filename).st_mode
44
os.chmod(filename, mod)
51
"""Return a quoted filename filename
53
This previously used backslash quoting, but that works poorly on
55
# TODO: I'm not really sure this is the best format either.x
58
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
60
if _QUOTE_RE.search(f):
67
mode = os.lstat(f)[ST_MODE]
86
def kind_marker(kind):
89
elif kind == 'directory':
91
elif kind == 'symlink':
94
raise BzrError('invalid file kind %r' % kind)
98
"""Copy a file to a backup.
100
Backups are named in GNU-style, with a ~ suffix.
102
If the file is already a backup, it's not copied.
114
outf = file(bfn, 'wb')
128
"""True if f is an accessible directory."""
130
return S_ISDIR(os.lstat(f)[ST_MODE])
136
"""True if f is a regular file."""
138
return S_ISREG(os.lstat(f)[ST_MODE])
143
def is_inside(dir, fname):
144
"""True if fname is inside dir.
146
The parameters should typically be passed to os.path.normpath first, so
147
that . and .. and repeated slashes are eliminated, and the separators
148
are canonical for the platform.
150
The empty string as a dir name is taken as top-of-tree and matches
153
>>> is_inside('src', os.path.join('src', 'foo.c'))
155
>>> is_inside('src', 'srccontrol')
157
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
159
>>> is_inside('foo.c', 'foo.c')
161
>>> is_inside('foo.c', '')
163
>>> is_inside('', 'foo.c')
166
# XXX: Most callers of this can actually do something smarter by
167
# looking at the inventory
174
if dir[-1] != os.sep:
177
return fname.startswith(dir)
180
def is_inside_any(dir_list, fname):
181
"""True if fname is inside any of given dirs."""
182
for dirname in dir_list:
183
if is_inside(dirname, fname):
189
def pumpfile(fromfile, tofile):
190
"""Copy contents of one file to another."""
191
tofile.write(fromfile.read())
195
if hasattr(f, 'tell'):
213
def fingerprint_file(f):
218
return {'size': size,
219
'sha1': s.hexdigest()}
223
"""Return per-user configuration directory.
225
By default this is ~/.bzr.conf/
227
TODO: Global option --config-dir to override this.
229
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
233
"""Calculate automatic user identification.
235
Returns (realname, email).
237
Only used when none is set in the environment or the id file.
239
This previously used the FQDN as the default domain, but that can
240
be very slow on machines where DNS is broken. So now we simply
245
# XXX: Any good way to get real user name on win32?
250
w = pwd.getpwuid(uid)
251
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
252
username = w.pw_name.decode(bzrlib.user_encoding)
253
comma = gecos.find(',')
257
realname = gecos[:comma]
263
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
265
return realname, (username + '@' + socket.gethostname())
268
def _get_user_id(branch):
269
"""Return the full user id from a file or environment variable.
271
e.g. "John Hacker <jhacker@foo.org>"
274
A branch to use for a per-branch configuration, or None.
276
The following are searched in order:
279
2. .bzr/email for this branch.
283
v = os.environ.get('BZREMAIL')
285
return v.decode(bzrlib.user_encoding)
289
return (branch.controlfile("email", "r")
291
.decode(bzrlib.user_encoding)
294
if e.errno != errno.ENOENT:
300
return (open(os.path.join(config_dir(), "email"))
302
.decode(bzrlib.user_encoding)
305
if e.errno != errno.ENOENT:
308
v = os.environ.get('EMAIL')
310
return v.decode(bzrlib.user_encoding)
315
def username(branch):
316
"""Return email-style username.
318
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
320
TODO: Check it's reasonably well-formed.
322
v = _get_user_id(branch)
326
name, email = _auto_user_id()
328
return '%s <%s>' % (name, email)
333
def user_email(branch):
334
"""Return just the email component of a username."""
335
e = _get_user_id(branch)
337
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
339
raise BzrError("%r doesn't seem to contain "
340
"a reasonable email address" % e)
343
return _auto_user_id()[1]
346
def compare_files(a, b):
347
"""Returns true if equal in contents"""
358
def local_time_offset(t=None):
359
"""Return offset of local zone from GMT, either at present or at time t."""
360
# python2.3 localtime() can't take None
364
if time.localtime(t).tm_isdst and time.daylight:
367
return -time.timezone
370
def format_date(t, offset=0, timezone='original'):
371
## TODO: Perhaps a global option to use either universal or local time?
372
## Or perhaps just let people set $TZ?
373
assert isinstance(t, float)
375
if timezone == 'utc':
378
elif timezone == 'original':
381
tt = time.gmtime(t + offset)
382
elif timezone == 'local':
383
tt = time.localtime(t)
384
offset = local_time_offset(t)
386
raise BzrError("unsupported timezone format %r" % timezone,
387
['options are "utc", "original", "local"'])
389
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
390
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
393
def compact_date(when):
394
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
399
"""Return size of given open file."""
400
return os.fstat(f.fileno())[ST_SIZE]
402
# Define rand_bytes based on platform.
404
# Python 2.4 and later have os.urandom,
405
# but it doesn't work on some arches
407
rand_bytes = os.urandom
408
except (NotImplementedError, AttributeError):
409
# If python doesn't have os.urandom, or it doesn't work,
410
# then try to first pull random data from /dev/urandom
411
if os.path.exists("/dev/urandom"):
412
rand_bytes = file('/dev/urandom', 'rb').read
413
# Otherwise, use this hack as a last resort
415
# not well seeded, but better than nothing
420
s += chr(random.randint(0, 255))
424
## TODO: We could later have path objects that remember their list
425
## decomposition (might be too tricksy though.)
428
"""Turn string into list of parts.
434
>>> splitpath('a/./b')
436
>>> splitpath('a/.b')
438
>>> splitpath('a/../b')
439
Traceback (most recent call last):
441
BzrError: sorry, '..' not allowed in path
443
assert isinstance(p, types.StringTypes)
445
# split on either delimiter because people might use either on
447
ps = re.split(r'[\\/]', p)
452
raise BzrError("sorry, %r not allowed in path" % f)
453
elif (f == '.') or (f == ''):
460
assert isinstance(p, list)
462
if (f == '..') or (f == None) or (f == ''):
463
raise BzrError("sorry, %r not allowed in path" % f)
464
return os.path.join(*p)
467
def appendpath(p1, p2):
471
return os.path.join(p1, p2)
474
def extern_command(cmd, ignore_errors = False):
475
mutter('external command: %s' % `cmd`)
477
if not ignore_errors:
478
raise BzrError('command failed')
481
def _read_config_value(name):
482
"""Read a config value from the file ~/.bzr.conf/<name>
483
Return None if the file does not exist"""
485
f = file(os.path.join(config_dir(), name), "r")
486
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
488
if e.errno == errno.ENOENT:
added
removed
bzrlib/osutils.py
