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
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
32
from bzrlib.config import config_dir, _get_user_id
33
from bzrlib.errors import BzrError
34
from bzrlib.trace import mutter
37
26
def make_readonly(filename):
38
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
39
29
mod = os.stat(filename).st_mode
40
30
mod = mod & 0777555
41
31
os.chmod(filename, mod)
47
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
54
"""Return a quoted filename filename
56
This previously used backslash quoting, but that works poorly on
58
# TODO: I'm not really sure this is the best format either.x
61
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
63
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)
75
56
elif S_ISLNK(mode):
89
def kind_marker(kind):
92
elif kind == 'directory':
94
elif kind == 'symlink':
97
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
125
"""Copy a file to a backup.
127
Backups are named in GNU-style, with a ~ suffix.
129
If the file is already a backup, it's not copied.
141
outf = file(bfn, 'wb')
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
170
"""True if f is a symlink."""
172
return S_ISLNK(os.lstat(f)[ST_MODE])
176
def is_inside(dir, fname):
177
"""True if fname is inside dir.
179
The parameters should typically be passed to os.path.normpath first, so
180
that . and .. and repeated slashes are eliminated, and the separators
181
are canonical for the platform.
183
The empty string as a dir name is taken as top-of-tree and matches
186
>>> is_inside('src', os.path.join('src', 'foo.c'))
188
>>> is_inside('src', 'srccontrol')
190
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
192
>>> is_inside('foo.c', 'foo.c')
194
>>> is_inside('foo.c', '')
196
>>> is_inside('', 'foo.c')
199
# XXX: Most callers of this can actually do something smarter by
200
# looking at the inventory
207
if dir[-1] != os.sep:
210
return fname.startswith(dir)
213
def is_inside_any(dir_list, fname):
214
"""True if fname is inside any of given dirs."""
215
for dirname in dir_list:
216
if is_inside(dirname, fname):
222
80
def pumpfile(fromfile, tofile):
223
81
"""Copy contents of one file to another."""
224
82
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())
228
95
if hasattr(f, 'tell'):
229
96
assert f.tell() == 0
260
122
'sha1': s.hexdigest()}
126
"""Return per-user configuration directory.
128
By default this is ~/.bzr.conf/
130
TODO: Global option --config-dir to override this.
132
return os.path.expanduser("~/.bzr.conf")
136
"""Calculate automatic user identification.
138
Returns (realname, email).
140
Only used when none is set in the environment or the id file.
142
This previously used the FQDN as the default domain, but that can
143
be very slow on machines where DNS is broken. So now we simply
148
# XXX: Any good way to get real user name on win32?
153
w = pwd.getpwuid(uid)
154
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
username = w.pw_name.decode(bzrlib.user_encoding)
156
comma = gecos.find(',')
160
realname = gecos[:comma]
166
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
168
return realname, (username + '@' + socket.gethostname())
172
"""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."""
176
v = os.environ.get('BZREMAIL')
178
return v.decode(bzrlib.user_encoding)
181
return (open(os.path.join(config_dir(), "email"))
183
.decode(bzrlib.user_encoding)
186
if e.errno != errno.ENOENT:
189
v = os.environ.get('EMAIL')
191
return v.decode(bzrlib.user_encoding)
197
"""Return email-style username.
199
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
201
TODO: Check it's reasonably well-formed.
207
name, email = _auto_user_id()
209
return '%s <%s>' % (name, email)
214
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
216
"""Return just the email component of a username."""
219
m = _EMAIL_RE.search(e)
221
bailout("%r doesn't seem to contain a reasonable email address" % e)
224
return _auto_user_id()[1]
263
228
def compare_files(a, b):
264
229
"""Returns true if equal in contents"""
300
266
tt = time.localtime(t)
301
267
offset = local_time_offset(t)
303
raise BzrError("unsupported timezone format %r" % timezone,
304
['options are "utc", "original", "local"'])
269
bailout("unsupported timezone format %r",
270
['options are "utc", "original", "local"'])
306
272
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
307
273
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
316
282
"""Return size of given open file."""
317
283
return os.fstat(f.fileno())[ST_SIZE]
319
# Define rand_bytes based on platform.
321
# Python 2.4 and later have os.urandom,
322
# but it doesn't work on some arches
286
if hasattr(os, 'urandom'): # python 2.4 and later
324
287
rand_bytes = os.urandom
325
except (NotImplementedError, AttributeError):
326
# If python doesn't have os.urandom, or it doesn't work,
327
# then try to first pull random data from /dev/urandom
328
if os.path.exists("/dev/urandom"):
329
rand_bytes = file('/dev/urandom', 'rb').read
330
# Otherwise, use this hack as a last resort
332
# not well seeded, but better than nothing
337
s += chr(random.randint(0, 255))
289
# FIXME: No good on non-Linux
290
_rand_file = file('/dev/urandom', 'rb')
291
rand_bytes = _rand_file.read
341
294
## TODO: We could later have path objects that remember their list
342
295
## decomposition (might be too tricksy though.)
355
308
>>> splitpath('a/../b')
356
309
Traceback (most recent call last):
358
BzrError: sorry, '..' not allowed in path
311
BzrError: ("sorry, '..' not allowed in path", [])
360
313
assert isinstance(p, types.StringTypes)
377
330
assert isinstance(p, list)
379
332
if (f == '..') or (f == None) or (f == ''):
380
raise BzrError("sorry, %r not allowed in path" % f)
333
bailout("sorry, %r not allowed in path" % f)
381
334
return os.path.join(*p)
388
341
return os.path.join(p1, p2)
392
"""Split s into lines, but without removing the newline characters."""
393
return StringIO(s).readlines()
396
def hardlinks_good():
397
return sys.platform not in ('win32', 'cygwin', 'darwin')
400
def link_or_copy(src, dest):
401
"""Hardlink a file, or copy it if it can't be hardlinked."""
402
if not hardlinks_good():
407
except (OSError, IOError), e:
408
if e.errno != errno.EXDEV:
414
if hasattr(os, 'symlink'):
344
def extern_command(cmd, ignore_errors = False):
345
mutter('external command: %s' % `cmd`)
347
if not ignore_errors:
348
bailout('command failed')
added
removed
bzrlib/osutils.py
