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)
22
from cStringIO import StringIO
32
from bzrlib.errors import BzrError
33
from bzrlib.trace import mutter
36
def make_readonly(filename):
37
"""Make a filename read-only."""
38
mod = os.stat(filename).st_mode
40
os.chmod(filename, mod)
43
def make_writable(filename):
44
mod = os.stat(filename).st_mode
46
os.chmod(filename, mod)
53
"""Return a quoted filename filename
55
This previously used backslash quoting, but that works poorly on
57
# TODO: I'm not really sure this is the best format either.x
60
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
62
if _QUOTE_RE.search(f):
69
mode = os.lstat(f)[ST_MODE]
88
def kind_marker(kind):
91
elif kind == 'directory':
93
elif kind == 'symlink':
96
raise BzrError('invalid file kind %r' % kind)
100
if hasattr(os, 'lstat'):
106
if e.errno == errno.ENOENT:
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
111
def normalizepath(f):
112
if hasattr(os.path, 'realpath'):
116
[p,e] = os.path.split(f)
117
if e == "" or e == "." or e == "..":
120
return os.path.join(F(p), e)
124
"""Copy a file to a backup.
126
Backups are named in GNU-style, with a ~ suffix.
128
If the file is already a backup, it's not copied.
140
outf = file(bfn, 'wb')
154
"""True if f is an accessible directory."""
156
return S_ISDIR(os.lstat(f)[ST_MODE])
162
"""True if f is a regular file."""
164
return S_ISREG(os.lstat(f)[ST_MODE])
169
"""True if f is a symlink."""
171
return S_ISLNK(os.lstat(f)[ST_MODE])
175
def is_inside(dir, fname):
176
"""True if fname is inside dir.
178
The parameters should typically be passed to os.path.normpath first, so
179
that . and .. and repeated slashes are eliminated, and the separators
180
are canonical for the platform.
182
The empty string as a dir name is taken as top-of-tree and matches
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
187
>>> is_inside('src', 'srccontrol')
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
191
>>> is_inside('foo.c', 'foo.c')
193
>>> is_inside('foo.c', '')
195
>>> is_inside('', 'foo.c')
198
# XXX: Most callers of this can actually do something smarter by
199
# looking at the inventory
206
if dir[-1] != os.sep:
209
return fname.startswith(dir)
212
def is_inside_any(dir_list, fname):
213
"""True if fname is inside any of given dirs."""
214
for dirname in dir_list:
215
if is_inside(dirname, fname):
221
def pumpfile(fromfile, tofile):
222
"""Copy contents of one file to another."""
223
tofile.write(fromfile.read())
227
if hasattr(f, 'tell'):
240
def sha_strings(strings):
241
"""Return the sha-1 of concatenation of strings"""
243
map(s.update, strings)
253
def fingerprint_file(f):
258
return {'size': size,
259
'sha1': s.hexdigest()}
263
"""Return per-user configuration directory.
265
By default this is ~/.bzr.conf/
267
TODO: Global option --config-dir to override this.
269
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
273
"""Calculate automatic user identification.
275
Returns (realname, email).
277
Only used when none is set in the environment or the id file.
279
This previously used the FQDN as the default domain, but that can
280
be very slow on machines where DNS is broken. So now we simply
285
# XXX: Any good way to get real user name on win32?
290
w = pwd.getpwuid(uid)
291
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
292
username = w.pw_name.decode(bzrlib.user_encoding)
293
comma = gecos.find(',')
297
realname = gecos[:comma]
303
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
309
"""Return the full user id from a file or environment variable.
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
323
v = os.environ.get('BZREMAIL')
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
340
return (open(os.path.join(config_dir(), "email"))
342
.decode(bzrlib.user_encoding)
345
if e.errno != errno.ENOENT:
348
v = os.environ.get('EMAIL')
350
return v.decode(bzrlib.user_encoding)
355
def username(branch):
356
"""Return email-style username.
358
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
360
TODO: Check it's reasonably well-formed.
362
v = _get_user_id(branch)
366
name, email = _auto_user_id()
368
return '%s <%s>' % (name, email)
373
def user_email(branch):
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
383
return _auto_user_id()[1]
386
def compare_files(a, b):
387
"""Returns true if equal in contents"""
398
def local_time_offset(t=None):
399
"""Return offset of local zone from GMT, either at present or at time t."""
400
# python2.3 localtime() can't take None
404
if time.localtime(t).tm_isdst and time.daylight:
407
return -time.timezone
410
def format_date(t, offset=0, timezone='original'):
411
## TODO: Perhaps a global option to use either universal or local time?
412
## Or perhaps just let people set $TZ?
413
assert isinstance(t, float)
415
if timezone == 'utc':
418
elif timezone == 'original':
421
tt = time.gmtime(t + offset)
422
elif timezone == 'local':
423
tt = time.localtime(t)
424
offset = local_time_offset(t)
426
raise BzrError("unsupported timezone format %r" % timezone,
427
['options are "utc", "original", "local"'])
429
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
430
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
433
def compact_date(when):
434
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
439
"""Return size of given open file."""
440
return os.fstat(f.fileno())[ST_SIZE]
442
# Define rand_bytes based on platform.
444
# Python 2.4 and later have os.urandom,
445
# but it doesn't work on some arches
447
rand_bytes = os.urandom
448
except (NotImplementedError, AttributeError):
449
# If python doesn't have os.urandom, or it doesn't work,
450
# then try to first pull random data from /dev/urandom
451
if os.path.exists("/dev/urandom"):
452
rand_bytes = file('/dev/urandom', 'rb').read
453
# Otherwise, use this hack as a last resort
455
# not well seeded, but better than nothing
460
s += chr(random.randint(0, 255))
464
## TODO: We could later have path objects that remember their list
465
## decomposition (might be too tricksy though.)
468
"""Turn string into list of parts.
474
>>> splitpath('a/./b')
476
>>> splitpath('a/.b')
478
>>> splitpath('a/../b')
479
Traceback (most recent call last):
481
BzrError: sorry, '..' not allowed in path
483
assert isinstance(p, types.StringTypes)
485
# split on either delimiter because people might use either on
487
ps = re.split(r'[\\/]', p)
492
raise BzrError("sorry, %r not allowed in path" % f)
493
elif (f == '.') or (f == ''):
500
assert isinstance(p, list)
502
if (f == '..') or (f == None) or (f == ''):
503
raise BzrError("sorry, %r not allowed in path" % f)
504
return os.path.join(*p)
507
def appendpath(p1, p2):
511
return os.path.join(p1, p2)
514
def _read_config_value(name):
515
"""Read a config value from the file ~/.bzr.conf/<name>
516
Return None if the file does not exist"""
518
f = file(os.path.join(config_dir(), name), "r")
519
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
521
if e.errno == errno.ENOENT:
527
"""Split s into lines, but without removing the newline characters."""
528
return StringIO(s).readlines()
531
def hardlinks_good():
532
return sys.platform not in ('win32', 'cygwin', 'darwin')
535
def link_or_copy(src, dest):
536
"""Hardlink a file, or copy it if it can't be hardlinked."""
537
if not hardlinks_good():
542
except (OSError, IOError), e:
543
if e.errno != errno.EXDEV:
549
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
