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, sys
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):
70
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.
134
if has_symlinks() and os.path.islink(fn):
135
target = os.readlink(fn)
136
os.symlink(target, bfn)
144
outf = file(bfn, 'wb')
173
"""True if f is a symlink."""
175
return S_ISLNK(os.lstat(f)[ST_MODE])
91
179
def is_inside(dir, fname):
92
180
"""True if fname is inside dir.
182
The parameters should typically be passed to os.path.normpath first, so
183
that . and .. and repeated slashes are eliminated, and the separators
184
are canonical for the platform.
186
The empty string as a dir name is taken as top-of-tree and matches
189
>>> is_inside('src', os.path.join('src', 'foo.c'))
191
>>> is_inside('src', 'srccontrol')
193
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
195
>>> is_inside('foo.c', 'foo.c')
197
>>> is_inside('foo.c', '')
199
>>> is_inside('', 'foo.c')
94
return os.path.commonprefix([dir, fname]) == dir
202
# XXX: Most callers of this can actually do something smarter by
203
# looking at the inventory
210
if dir[-1] != os.sep:
213
return fname.startswith(dir)
97
216
def is_inside_any(dir_list, fname):
98
217
"""True if fname is inside any of given dirs."""
99
# quick scan for perfect match
100
if fname in dir_list:
103
218
for dirname in dir_list:
104
219
if is_inside(dirname, fname):
152
263
'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]
258
266
def compare_files(a, b):
259
267
"""Returns true if equal in contents"""
296
303
tt = time.localtime(t)
297
304
offset = local_time_offset(t)
299
bailout("unsupported timezone format %r",
300
['options are "utc", "original", "local"'])
306
raise BzrError("unsupported timezone format %r" % timezone,
307
['options are "utc", "original", "local"'])
302
309
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
303
310
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
312
319
"""Return size of given open file."""
313
320
return os.fstat(f.fileno())[ST_SIZE]
316
if hasattr(os, 'urandom'): # python 2.4 and later
322
# Define rand_bytes based on platform.
324
# Python 2.4 and later have os.urandom,
325
# but it doesn't work on some arches
317
327
rand_bytes = os.urandom
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))
328
except (NotImplementedError, AttributeError):
329
# If python doesn't have os.urandom, or it doesn't work,
330
# then try to first pull random data from /dev/urandom
331
if os.path.exists("/dev/urandom"):
332
rand_bytes = file('/dev/urandom', 'rb').read
333
# Otherwise, use this hack as a last resort
335
# not well seeded, but better than nothing
340
s += chr(random.randint(0, 255))
331
344
## TODO: We could later have path objects that remember their list
332
345
## decomposition (might be too tricksy though.)
345
358
>>> splitpath('a/../b')
346
359
Traceback (most recent call last):
348
BzrError: ("sorry, '..' not allowed in path", [])
361
BzrError: sorry, '..' not allowed in path
350
363
assert isinstance(p, types.StringTypes)
367
380
assert isinstance(p, list)
369
382
if (f == '..') or (f == None) or (f == ''):
370
bailout("sorry, %r not allowed in path" % f)
383
raise BzrError("sorry, %r not allowed in path" % f)
371
384
return os.path.join(*p)
378
391
return os.path.join(p1, p2)
381
def extern_command(cmd, ignore_errors = False):
382
mutter('external command: %s' % `cmd`)
384
if not ignore_errors:
385
bailout('command failed')
395
"""Split s into lines, but without removing the newline characters."""
396
return StringIO(s).readlines()
399
def hardlinks_good():
400
return sys.platform not in ('win32', 'cygwin', 'darwin')
403
def link_or_copy(src, dest):
404
"""Hardlink a file, or copy it if it can't be hardlinked."""
405
if not hardlinks_good():
410
except (OSError, IOError), e:
411
if e.errno != errno.EXDEV:
417
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
