1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
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
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
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
22
from errors import bailout, BzrError
23
from trace import mutter
32
from bzrlib.errors import BzrError
33
from bzrlib.trace import mutter
26
36
def make_readonly(filename):
27
37
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
38
mod = os.stat(filename).st_mode
30
39
mod = mod & 0777555
31
40
os.chmod(filename, mod)
37
46
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
42
"""Return shell-quoted filename"""
43
## We could be a bit more terse by using double-quotes etc
44
f = _QUOTE_RE.sub(r'\\\1', f)
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):
56
74
elif S_ISLNK(mode):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
88
def kind_marker(kind):
91
elif kind == 'directory':
93
elif kind == 'symlink':
96
raise BzrError('invalid file kind %r' % kind)
100
"""Copy a file to a backup.
102
Backups are named in GNU-style, with a ~ suffix.
104
If the file is already a backup, it's not copied.
116
outf = file(bfn, 'wb')
145
def is_inside(dir, fname):
146
"""True if fname is inside dir.
148
The parameters should typically be passed to os.path.normpath first, so
149
that . and .. and repeated slashes are eliminated, and the separators
150
are canonical for the platform.
152
The empty string as a dir name is taken as top-of-tree and matches
155
>>> is_inside('src', os.path.join('src', 'foo.c'))
157
>>> is_inside('src', 'srccontrol')
159
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
161
>>> is_inside('foo.c', 'foo.c')
163
>>> is_inside('foo.c', '')
165
>>> is_inside('', 'foo.c')
168
# XXX: Most callers of this can actually do something smarter by
169
# looking at the inventory
176
if dir[-1] != os.sep:
179
return fname.startswith(dir)
182
def is_inside_any(dir_list, fname):
183
"""True if fname is inside any of given dirs."""
184
for dirname in dir_list:
185
if is_inside(dirname, fname):
80
191
def pumpfile(fromfile, tofile):
81
192
"""Copy contents of one file to another."""
82
193
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
90
return chomp(os.popen('uuidgen').readline())
95
197
if hasattr(f, 'tell'):
96
198
assert f.tell() == 0
168
275
return realname, (username + '@' + socket.gethostname())
278
def _get_user_id(branch):
172
279
"""Return the full user id from a file or environment variable.
174
TODO: Allow taking this from a file in the branch directory too
175
for per-branch ids."""
281
e.g. "John Hacker <jhacker@foo.org>"
284
A branch to use for a per-branch configuration, or None.
286
The following are searched in order:
289
2. .bzr/email for this branch.
176
293
v = os.environ.get('BZREMAIL')
178
295
return v.decode(bzrlib.user_encoding)
299
return (branch.controlfile("email", "r")
301
.decode(bzrlib.user_encoding)
304
if e.errno != errno.ENOENT:
181
310
return (open(os.path.join(config_dir(), "email"))
214
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
343
def user_email(branch):
216
344
"""Return just the email component of a username."""
345
e = _get_user_id(branch)
219
m = _EMAIL_RE.search(e)
347
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
221
bailout("%r doesn't seem to contain a reasonable email address" % e)
349
raise BzrError("%r doesn't seem to contain "
350
"a reasonable email address" % e)
222
351
return m.group(0)
224
353
return _auto_user_id()[1]
228
356
def compare_files(a, b):
266
393
tt = time.localtime(t)
267
394
offset = local_time_offset(t)
269
bailout("unsupported timezone format %r",
270
['options are "utc", "original", "local"'])
396
raise BzrError("unsupported timezone format %r" % timezone,
397
['options are "utc", "original", "local"'])
272
399
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
400
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
282
409
"""Return size of given open file."""
283
410
return os.fstat(f.fileno())[ST_SIZE]
286
if hasattr(os, 'urandom'): # python 2.4 and later
412
# Define rand_bytes based on platform.
414
# Python 2.4 and later have os.urandom,
415
# but it doesn't work on some arches
287
417
rand_bytes = os.urandom
289
# FIXME: No good on non-Linux
290
_rand_file = file('/dev/urandom', 'rb')
291
rand_bytes = _rand_file.read
418
except (NotImplementedError, AttributeError):
419
# If python doesn't have os.urandom, or it doesn't work,
420
# then try to first pull random data from /dev/urandom
421
if os.path.exists("/dev/urandom"):
422
rand_bytes = file('/dev/urandom', 'rb').read
423
# Otherwise, use this hack as a last resort
425
# not well seeded, but better than nothing
430
s += chr(random.randint(0, 255))
294
434
## TODO: We could later have path objects that remember their list
295
435
## decomposition (might be too tricksy though.)
308
448
>>> splitpath('a/../b')
309
449
Traceback (most recent call last):
311
BzrError: ("sorry, '..' not allowed in path", [])
451
BzrError: sorry, '..' not allowed in path
313
453
assert isinstance(p, types.StringTypes)
330
470
assert isinstance(p, list)
332
472
if (f == '..') or (f == None) or (f == ''):
333
bailout("sorry, %r not allowed in path" % f)
473
raise BzrError("sorry, %r not allowed in path" % f)
334
474
return os.path.join(*p)
341
481
return os.path.join(p1, p2)
344
def extern_command(cmd, ignore_errors = False):
345
mutter('external command: %s' % `cmd`)
347
if not ignore_errors:
348
bailout('command failed')
484
def _read_config_value(name):
485
"""Read a config value from the file ~/.bzr.conf/<name>
486
Return None if the file does not exist"""
488
f = file(os.path.join(config_dir(), name), "r")
489
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
491
if e.errno == errno.ENOENT:
497
"""Split s into lines, but without removing the newline characters."""
498
return StringIO(s).readlines()
501
def hardlinks_good():
502
return sys.platform not in ('win32', 'cygwin', 'darwin')
505
def link_or_copy(src, dest):
506
"""Hardlink a file, or copy it if it can't be hardlinked."""
507
if not hardlinks_good():
512
except (OSError, IOError), e:
513
if e.errno != errno.EXDEV:
added
removed
bzrlib/osutils.py
