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
33
from bzrlib.errors import BzrError, NotBranchError
34
from bzrlib.trace import mutter
26
37
def make_readonly(filename):
27
38
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
39
mod = os.stat(filename).st_mode
30
40
mod = mod & 0777555
31
41
os.chmod(filename, mod)
37
47
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)
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):
56
75
elif S_ISLNK(mode):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
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')
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):
80
241
def pumpfile(fromfile, tofile):
81
242
"""Copy contents of one file to another."""
82
243
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
89
## Linux, but we need something portable for other systems;
90
## preferably an implementation in Python.
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
94
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
107
247
if hasattr(f, 'tell'):
108
248
assert f.tell() == 0
260
def sha_strings(strings):
261
"""Return the sha-1 of concatenation of strings"""
263
map(s.update, strings)
111
264
return s.hexdigest()
114
267
def sha_string(f):
118
270
return s.hexdigest()
122
273
def fingerprint_file(f):
129
279
'sha1': s.hexdigest()}
133
"""Return per-user configuration directory.
135
By default this is ~/.bzr.conf/
137
TODO: Global option --config-dir to override this.
139
return os.path.expanduser("~/.bzr.conf")
143
"""Calculate automatic user identification.
145
Returns (realname, email).
147
Only used when none is set in the environment or the id file.
149
This previously used the FQDN as the default domain, but that can
150
be very slow on machines where DNS is broken. So now we simply
155
# XXX: Any good way to get real user name on win32?
160
w = pwd.getpwuid(uid)
161
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
162
username = w.pw_name.decode(bzrlib.user_encoding)
163
comma = gecos.find(',')
167
realname = gecos[:comma]
173
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
175
return realname, (username + '@' + socket.gethostname())
179
"""Return the full user id from a file or environment variable.
181
TODO: Allow taking this from a file in the branch directory too
182
for per-branch ids."""
183
v = os.environ.get('BZREMAIL')
185
return v.decode(bzrlib.user_encoding)
188
return (open(os.path.join(config_dir(), "email"))
190
.decode(bzrlib.user_encoding)
193
if e.errno != errno.ENOENT:
196
v = os.environ.get('EMAIL')
198
return v.decode(bzrlib.user_encoding)
204
"""Return email-style username.
206
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
208
TODO: Check it's reasonably well-formed.
214
name, email = _auto_user_id()
216
return '%s <%s>' % (name, email)
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
223
"""Return just the email component of a username."""
226
m = _EMAIL_RE.search(e)
228
bailout("%r doesn't seem to contain a reasonable email address" % e)
231
return _auto_user_id()[1]
235
282
def compare_files(a, b):
236
283
"""Returns true if equal in contents"""
237
# TODO: don't read the whole thing in one go.
240
286
ai = a.read(BUFSIZE)
258
303
return -time.timezone
261
def format_date(t, offset=0, timezone='original'):
306
def format_date(t, offset=0, timezone='original', date_fmt=None,
262
308
## TODO: Perhaps a global option to use either universal or local time?
263
309
## Or perhaps just let people set $TZ?
264
310
assert isinstance(t, float)
274
320
tt = time.localtime(t)
275
321
offset = local_time_offset(t)
277
bailout("unsupported timezone format %r",
278
['options are "utc", "original", "local"'])
280
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
281
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
323
raise BzrError("unsupported timezone format %r" % timezone,
324
['options are "utc", "original", "local"'])
326
date_fmt = "%a %Y-%m-%d %H:%M:%S"
328
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
331
return (time.strftime(date_fmt, tt) + offset_str)
284
334
def compact_date(when):
290
340
"""Return size of given open file."""
291
341
return os.fstat(f.fileno())[ST_SIZE]
294
if hasattr(os, 'urandom'): # python 2.4 and later
343
# Define rand_bytes based on platform.
345
# Python 2.4 and later have os.urandom,
346
# but it doesn't work on some arches
295
348
rand_bytes = os.urandom
297
# FIXME: No good on non-Linux
298
_rand_file = file('/dev/urandom', 'rb')
299
rand_bytes = _rand_file.read
349
except (NotImplementedError, AttributeError):
350
# If python doesn't have os.urandom, or it doesn't work,
351
# then try to first pull random data from /dev/urandom
352
if os.path.exists("/dev/urandom"):
353
rand_bytes = file('/dev/urandom', 'rb').read
354
# Otherwise, use this hack as a last resort
356
# not well seeded, but better than nothing
361
s += chr(random.randint(0, 255))
302
365
## TODO: We could later have path objects that remember their list
303
366
## decomposition (might be too tricksy though.)
316
379
>>> splitpath('a/../b')
317
380
Traceback (most recent call last):
319
BzrError: ("sorry, '..' not allowed in path", [])
382
BzrError: sorry, '..' not allowed in path
321
384
assert isinstance(p, types.StringTypes)
338
401
assert isinstance(p, list)
340
403
if (f == '..') or (f == None) or (f == ''):
341
bailout("sorry, %r not allowed in path" % f)
404
raise BzrError("sorry, %r not allowed in path" % f)
342
405
return os.path.join(*p)
349
412
return os.path.join(p1, p2)
352
def extern_command(cmd, ignore_errors = False):
353
mutter('external command: %s' % `cmd`)
355
if not ignore_errors:
356
bailout('command failed')
416
"""Split s into lines, but without removing the newline characters."""
417
return StringIO(s).readlines()
420
def hardlinks_good():
421
return sys.platform not in ('win32', 'cygwin', 'darwin')
424
def link_or_copy(src, dest):
425
"""Hardlink a file, or copy it if it can't be hardlinked."""
426
if not hardlinks_good():
431
except (OSError, IOError), e:
432
if e.errno != errno.EXDEV:
438
if hasattr(os, 'symlink'):
444
def contains_whitespace(s):
445
"""True if there are any whitespace characters in s."""
446
for ch in string.whitespace:
453
def contains_linebreaks(s):
454
"""True if there is any vertical whitespace in s."""
462
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
465
The path may be either an absolute path or a path relative to the
466
current working directory.
468
os.path.commonprefix (python2.4) has a bad bug that it works just
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
475
while len(head) >= len(base):
478
head, tail = os.path.split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
added
removed
bzrlib/osutils.py
