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 shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
31
from bzrlib.errors import BzrError
32
from bzrlib.trace import mutter
35
def make_readonly(filename):
36
"""Make a filename read-only."""
37
mod = os.stat(filename).st_mode
39
os.chmod(filename, mod)
42
def make_writable(filename):
43
mod = os.stat(filename).st_mode
45
os.chmod(filename, mod)
52
"""Return a quoted filename filename
54
This previously used backslash quoting, but that works poorly on
56
# TODO: I'm not really sure this is the best format either.x
59
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
61
if _QUOTE_RE.search(f):
68
mode = os.lstat(f)[ST_MODE]
87
def kind_marker(kind):
90
elif kind == 'directory':
92
elif kind == 'symlink':
95
raise BzrError('invalid file kind %r' % kind)
99
if hasattr(os, 'lstat'):
105
if e.errno == errno.ENOENT:
108
raise BzrError("lstat/stat of (%r): %r" % (f, e))
110
def normalizepath(f):
111
if hasattr(os.path, 'realpath'):
115
[p,e] = os.path.split(f)
116
if e == "" or e == "." or e == "..":
119
return os.path.join(F(p), e)
123
"""Copy a file to a backup.
125
Backups are named in GNU-style, with a ~ suffix.
127
If the file is already a backup, it's not copied.
139
outf = file(bfn, 'wb')
153
"""True if f is an accessible directory."""
155
return S_ISDIR(os.lstat(f)[ST_MODE])
161
"""True if f is a regular file."""
163
return S_ISREG(os.lstat(f)[ST_MODE])
168
"""True if f is a symlink."""
170
return S_ISLNK(os.lstat(f)[ST_MODE])
174
def is_inside(dir, fname):
175
"""True if fname is inside dir.
177
The parameters should typically be passed to os.path.normpath first, so
178
that . and .. and repeated slashes are eliminated, and the separators
179
are canonical for the platform.
181
The empty string as a dir name is taken as top-of-tree and matches
184
>>> is_inside('src', os.path.join('src', 'foo.c'))
186
>>> is_inside('src', 'srccontrol')
188
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
190
>>> is_inside('foo.c', 'foo.c')
192
>>> is_inside('foo.c', '')
194
>>> is_inside('', 'foo.c')
197
# XXX: Most callers of this can actually do something smarter by
198
# looking at the inventory
205
if dir[-1] != os.sep:
208
return fname.startswith(dir)
211
def is_inside_any(dir_list, fname):
212
"""True if fname is inside any of given dirs."""
213
for dirname in dir_list:
214
if is_inside(dirname, fname):
220
def pumpfile(fromfile, tofile):
221
"""Copy contents of one file to another."""
222
tofile.write(fromfile.read())
226
if hasattr(f, 'tell'):
244
def fingerprint_file(f):
249
return {'size': size,
250
'sha1': s.hexdigest()}
254
"""Return per-user configuration directory.
256
By default this is ~/.bzr.conf/
258
TODO: Global option --config-dir to override this.
260
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
264
"""Calculate automatic user identification.
266
Returns (realname, email).
268
Only used when none is set in the environment or the id file.
270
This previously used the FQDN as the default domain, but that can
271
be very slow on machines where DNS is broken. So now we simply
276
# XXX: Any good way to get real user name on win32?
281
w = pwd.getpwuid(uid)
282
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
283
username = w.pw_name.decode(bzrlib.user_encoding)
284
comma = gecos.find(',')
288
realname = gecos[:comma]
294
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
296
return realname, (username + '@' + socket.gethostname())
299
def _get_user_id(branch):
300
"""Return the full user id from a file or environment variable.
302
e.g. "John Hacker <jhacker@foo.org>"
305
A branch to use for a per-branch configuration, or None.
307
The following are searched in order:
310
2. .bzr/email for this branch.
314
v = os.environ.get('BZREMAIL')
316
return v.decode(bzrlib.user_encoding)
320
return (branch.controlfile("email", "r")
322
.decode(bzrlib.user_encoding)
325
if e.errno != errno.ENOENT:
331
return (open(os.path.join(config_dir(), "email"))
333
.decode(bzrlib.user_encoding)
336
if e.errno != errno.ENOENT:
339
v = os.environ.get('EMAIL')
341
return v.decode(bzrlib.user_encoding)
346
def username(branch):
347
"""Return email-style username.
349
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
351
TODO: Check it's reasonably well-formed.
353
v = _get_user_id(branch)
357
name, email = _auto_user_id()
359
return '%s <%s>' % (name, email)
364
def user_email(branch):
365
"""Return just the email component of a username."""
366
e = _get_user_id(branch)
368
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
370
raise BzrError("%r doesn't seem to contain "
371
"a reasonable email address" % e)
374
return _auto_user_id()[1]
377
def compare_files(a, b):
378
"""Returns true if equal in contents"""
389
def local_time_offset(t=None):
390
"""Return offset of local zone from GMT, either at present or at time t."""
391
# python2.3 localtime() can't take None
395
if time.localtime(t).tm_isdst and time.daylight:
398
return -time.timezone
401
def format_date(t, offset=0, timezone='original'):
402
## TODO: Perhaps a global option to use either universal or local time?
403
## Or perhaps just let people set $TZ?
404
assert isinstance(t, float)
406
if timezone == 'utc':
409
elif timezone == 'original':
412
tt = time.gmtime(t + offset)
413
elif timezone == 'local':
414
tt = time.localtime(t)
415
offset = local_time_offset(t)
417
raise BzrError("unsupported timezone format %r" % timezone,
418
['options are "utc", "original", "local"'])
420
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
421
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
424
def compact_date(when):
425
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
430
"""Return size of given open file."""
431
return os.fstat(f.fileno())[ST_SIZE]
433
# Define rand_bytes based on platform.
435
# Python 2.4 and later have os.urandom,
436
# but it doesn't work on some arches
438
rand_bytes = os.urandom
439
except (NotImplementedError, AttributeError):
440
# If python doesn't have os.urandom, or it doesn't work,
441
# then try to first pull random data from /dev/urandom
442
if os.path.exists("/dev/urandom"):
443
rand_bytes = file('/dev/urandom', 'rb').read
444
# Otherwise, use this hack as a last resort
446
# not well seeded, but better than nothing
451
s += chr(random.randint(0, 255))
455
## TODO: We could later have path objects that remember their list
456
## decomposition (might be too tricksy though.)
459
"""Turn string into list of parts.
465
>>> splitpath('a/./b')
467
>>> splitpath('a/.b')
469
>>> splitpath('a/../b')
470
Traceback (most recent call last):
472
BzrError: sorry, '..' not allowed in path
474
assert isinstance(p, types.StringTypes)
476
# split on either delimiter because people might use either on
478
ps = re.split(r'[\\/]', p)
483
raise BzrError("sorry, %r not allowed in path" % f)
484
elif (f == '.') or (f == ''):
491
assert isinstance(p, list)
493
if (f == '..') or (f == None) or (f == ''):
494
raise BzrError("sorry, %r not allowed in path" % f)
495
return os.path.join(*p)
498
def appendpath(p1, p2):
502
return os.path.join(p1, p2)
505
def _read_config_value(name):
506
"""Read a config value from the file ~/.bzr.conf/<name>
507
Return None if the file does not exist"""
509
f = file(os.path.join(config_dir(), name), "r")
510
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
512
if e.errno == errno.ENOENT:
517
def hardlinks_good():
518
return sys.platform not in ('win32', 'cygwin', 'darwin')
521
def link_or_copy(src, dest):
522
"""Hardlink a file, or copy it if it can't be hardlinked."""
523
if not hardlinks_good():
528
except (OSError, IOError), e:
529
if e.errno != errno.EXDEV:
added
removed
bzrlib/osutils.py
