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
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
19
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from errors import bailout, BzrError
23
from trace import mutter
33
from bzrlib.config import config_dir, _get_user_id
34
from bzrlib.errors import BzrError
35
from bzrlib.trace import mutter
38
26
def make_readonly(filename):
39
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
40
29
mod = os.stat(filename).st_mode
41
30
mod = mod & 0777555
42
31
os.chmod(filename, mod)
48
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
55
"""Return a quoted filename filename
57
This previously used backslash quoting, but that works poorly on
59
# TODO: I'm not really sure this is the best format either.x
62
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
64
if _QUOTE_RE.search(f):
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)
98
70
raise BzrError('invalid file kind %r' % kind)
102
if hasattr(os, 'lstat'):
108
if e.errno == errno.ENOENT:
111
raise BzrError("lstat/stat of (%r): %r" % (f, e))
113
def normalizepath(f):
114
if hasattr(os.path, 'realpath'):
118
[p,e] = os.path.split(f)
119
if e == "" or e == "." or e == "..":
122
return os.path.join(F(p), e)
126
"""Copy a file to a backup.
128
Backups are named in GNU-style, with a ~ suffix.
130
If the file is already a backup, it's not copied.
136
if has_symlinks() and os.path.islink(fn):
137
target = os.readlink(fn)
138
os.symlink(target, bfn)
146
outf = file(bfn, 'wb')
175
"""True if f is a symlink."""
177
return S_ISLNK(os.lstat(f)[ST_MODE])
181
91
def is_inside(dir, fname):
182
92
"""True if fname is inside dir.
184
The parameters should typically be passed to os.path.normpath first, so
185
that . and .. and repeated slashes are eliminated, and the separators
186
are canonical for the platform.
188
The empty string as a dir name is taken as top-of-tree and matches
191
>>> is_inside('src', os.path.join('src', 'foo.c'))
193
>>> is_inside('src', 'srccontrol')
195
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
197
>>> is_inside('foo.c', 'foo.c')
199
>>> is_inside('foo.c', '')
201
>>> is_inside('', 'foo.c')
204
# XXX: Most callers of this can actually do something smarter by
205
# looking at the inventory
212
if dir[-1] != os.sep:
215
return fname.startswith(dir)
94
return os.path.commonprefix([dir, fname]) == dir
218
97
def is_inside_any(dir_list, fname):
219
98
"""True if fname is inside any of given dirs."""
99
# quick scan for perfect match
100
if fname in dir_list:
220
103
for dirname in dir_list:
221
104
if is_inside(dirname, fname):
265
152
'sha1': s.hexdigest()}
156
"""Return per-user configuration directory.
158
By default this is ~/.bzr.conf/
160
TODO: Global option --config-dir to override this.
162
return os.path.expanduser("~/.bzr.conf")
166
"""Calculate automatic user identification.
168
Returns (realname, email).
170
Only used when none is set in the environment or the id file.
172
This previously used the FQDN as the default domain, but that can
173
be very slow on machines where DNS is broken. So now we simply
178
# XXX: Any good way to get real user name on win32?
183
w = pwd.getpwuid(uid)
184
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
185
username = w.pw_name.decode(bzrlib.user_encoding)
186
comma = gecos.find(',')
190
realname = gecos[:comma]
196
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
198
return realname, (username + '@' + socket.gethostname())
202
"""Return the full user id from a file or environment variable.
204
TODO: Allow taking this from a file in the branch directory too
205
for per-branch ids."""
206
v = os.environ.get('BZREMAIL')
208
return v.decode(bzrlib.user_encoding)
211
return (open(os.path.join(config_dir(), "email"))
213
.decode(bzrlib.user_encoding)
216
if e.errno != errno.ENOENT:
219
v = os.environ.get('EMAIL')
221
return v.decode(bzrlib.user_encoding)
227
"""Return email-style username.
229
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
231
TODO: Check it's reasonably well-formed.
237
name, email = _auto_user_id()
239
return '%s <%s>' % (name, email)
244
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
246
"""Return just the email component of a username."""
249
m = _EMAIL_RE.search(e)
251
bailout("%r doesn't seem to contain a reasonable email address" % e)
254
return _auto_user_id()[1]
268
258
def compare_files(a, b):
269
259
"""Returns true if equal in contents"""
305
296
tt = time.localtime(t)
306
297
offset = local_time_offset(t)
308
raise BzrError("unsupported timezone format %r" % timezone,
309
['options are "utc", "original", "local"'])
299
bailout("unsupported timezone format %r",
300
['options are "utc", "original", "local"'])
311
302
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
312
303
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
321
312
"""Return size of given open file."""
322
313
return os.fstat(f.fileno())[ST_SIZE]
324
# Define rand_bytes based on platform.
326
# Python 2.4 and later have os.urandom,
327
# but it doesn't work on some arches
316
if hasattr(os, 'urandom'): # python 2.4 and later
329
317
rand_bytes = os.urandom
330
except (NotImplementedError, AttributeError):
331
# If python doesn't have os.urandom, or it doesn't work,
332
# then try to first pull random data from /dev/urandom
333
if os.path.exists("/dev/urandom"):
334
rand_bytes = file('/dev/urandom', 'rb').read
335
# Otherwise, use this hack as a last resort
337
# not well seeded, but better than nothing
342
s += chr(random.randint(0, 255))
318
elif sys.platform == 'linux2':
319
rand_bytes = file('/dev/urandom', 'rb').read
321
# not well seeded, but better than nothing
326
s += chr(random.randint(0, 255))
346
331
## TODO: We could later have path objects that remember their list
347
332
## decomposition (might be too tricksy though.)
360
345
>>> splitpath('a/../b')
361
346
Traceback (most recent call last):
363
BzrError: sorry, '..' not allowed in path
348
BzrError: ("sorry, '..' not allowed in path", [])
365
350
assert isinstance(p, types.StringTypes)
382
367
assert isinstance(p, list)
384
369
if (f == '..') or (f == None) or (f == ''):
385
raise BzrError("sorry, %r not allowed in path" % f)
370
bailout("sorry, %r not allowed in path" % f)
386
371
return os.path.join(*p)
393
378
return os.path.join(p1, p2)
397
"""Split s into lines, but without removing the newline characters."""
398
return StringIO(s).readlines()
401
def hardlinks_good():
402
return sys.platform not in ('win32', 'cygwin', 'darwin')
405
def link_or_copy(src, dest):
406
"""Hardlink a file, or copy it if it can't be hardlinked."""
407
if not hardlinks_good():
412
except (OSError, IOError), e:
413
if e.errno != errno.EXDEV:
419
if hasattr(os, 'symlink'):
425
def contains_whitespace(s):
426
"""True if there are any whitespace characters in s."""
427
for ch in string.whitespace:
434
def contains_linebreaks(s):
435
"""True if there is any vertical whitespace in s."""
381
def extern_command(cmd, ignore_errors = False):
382
mutter('external command: %s' % `cmd`)
384
if not ignore_errors:
385
bailout('command failed')
added
removed
bzrlib/osutils.py
