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
33
from bzrlib.errors import BzrError, PathNotChild
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)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
140
"""Copy a file to a backup.
142
Backups are named in GNU-style, with a ~ suffix.
144
If the file is already a backup, it's not copied.
150
if has_symlinks() and os.path.islink(fn):
151
target = os.readlink(fn)
152
os.symlink(target, bfn)
160
outf = file(bfn, 'wb')
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
189
"""True if f is a symlink."""
191
return S_ISLNK(os.lstat(f)[ST_MODE])
195
def is_inside(dir, fname):
196
"""True if fname is inside dir.
198
The parameters should typically be passed to os.path.normpath first, so
199
that . and .. and repeated slashes are eliminated, and the separators
200
are canonical for the platform.
202
The empty string as a dir name is taken as top-of-tree and matches
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
207
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
211
>>> is_inside('foo.c', 'foo.c')
213
>>> is_inside('foo.c', '')
215
>>> is_inside('', 'foo.c')
218
# XXX: Most callers of this can actually do something smarter by
219
# looking at the inventory
226
if dir[-1] != os.sep:
229
return fname.startswith(dir)
232
def is_inside_any(dir_list, fname):
233
"""True if fname is inside any of given dirs."""
234
for dirname in dir_list:
235
if is_inside(dirname, fname):
241
80
def pumpfile(fromfile, tofile):
242
81
"""Copy contents of one file to another."""
245
b = fromfile.read(BUFSIZE)
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())
252
95
if hasattr(f, 'tell'):
253
96
assert f.tell() == 0
284
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]
287
228
def compare_files(a, b):
288
229
"""Returns true if equal in contents"""
308
250
return -time.timezone
311
def format_date(t, offset=0, timezone='original', date_fmt=None,
253
def format_date(t, offset=0, timezone='original'):
313
254
## TODO: Perhaps a global option to use either universal or local time?
314
255
## Or perhaps just let people set $TZ?
315
256
assert isinstance(t, float)
325
266
tt = time.localtime(t)
326
267
offset = local_time_offset(t)
328
raise BzrError("unsupported timezone format %r" % timezone,
329
['options are "utc", "original", "local"'])
331
date_fmt = "%a %Y-%m-%d %H:%M:%S"
333
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
336
return (time.strftime(date_fmt, tt) + offset_str)
269
bailout("unsupported timezone format %r",
270
['options are "utc", "original", "local"'])
272
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
339
276
def compact_date(when):
345
282
"""Return size of given open file."""
346
283
return os.fstat(f.fileno())[ST_SIZE]
348
# Define rand_bytes based on platform.
350
# Python 2.4 and later have os.urandom,
351
# but it doesn't work on some arches
286
if hasattr(os, 'urandom'): # python 2.4 and later
353
287
rand_bytes = os.urandom
354
except (NotImplementedError, AttributeError):
355
# If python doesn't have os.urandom, or it doesn't work,
356
# then try to first pull random data from /dev/urandom
357
if os.path.exists("/dev/urandom"):
358
rand_bytes = file('/dev/urandom', 'rb').read
359
# Otherwise, use this hack as a last resort
361
# not well seeded, but better than nothing
366
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
370
294
## TODO: We could later have path objects that remember their list
371
295
## decomposition (might be too tricksy though.)
384
308
>>> splitpath('a/../b')
385
309
Traceback (most recent call last):
387
BzrError: sorry, '..' not allowed in path
311
BzrError: ("sorry, '..' not allowed in path", [])
389
313
assert isinstance(p, types.StringTypes)
406
330
assert isinstance(p, list)
408
332
if (f == '..') or (f == None) or (f == ''):
409
raise BzrError("sorry, %r not allowed in path" % f)
333
bailout("sorry, %r not allowed in path" % f)
410
334
return os.path.join(*p)
417
341
return os.path.join(p1, p2)
421
"""Split s into lines, but without removing the newline characters."""
422
return StringIO(s).readlines()
425
def hardlinks_good():
426
return sys.platform not in ('win32', 'cygwin', 'darwin')
429
def link_or_copy(src, dest):
430
"""Hardlink a file, or copy it if it can't be hardlinked."""
431
if not hardlinks_good():
436
except (OSError, IOError), e:
437
if e.errno != errno.EXDEV:
443
if hasattr(os, 'symlink'):
449
def contains_whitespace(s):
450
"""True if there are any whitespace characters in s."""
451
for ch in string.whitespace:
458
def contains_linebreaks(s):
459
"""True if there is any vertical whitespace in s."""
467
def relpath(base, path):
468
"""Return path relative to base, or raise exception.
470
The path may be either an absolute path or a path relative to the
471
current working directory.
473
os.path.commonprefix (python2.4) has a bad bug that it works just
474
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
475
avoids that problem."""
480
while len(head) >= len(base):
483
head, tail = os.path.split(head)
487
# XXX This should raise a NotChildPath exception, as its not tied
489
raise PathNotChild(rp, base)
491
return os.sep.join(s)
495
def terminal_width():
496
"""Return estimated terminal width."""
498
# TODO: Do something smart on Windows?
500
# TODO: Is there anything that gets a better update when the window
501
# is resized while the program is running? We could use the Python termcap
504
return int(os.environ['COLUMNS'])
505
except (IndexError, KeyError, ValueError):
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
