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
33
from bzrlib.errors import BzrError, PathNotChild
34
from bzrlib.trace import mutter
19
import os, types, re, time, types
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from errors import bailout
37
24
def make_readonly(filename):
38
25
"""Make a filename read-only."""
26
# TODO: probably needs to be fixed for windows
39
27
mod = os.stat(filename).st_mode
40
28
mod = mod & 0777555
41
29
os.chmod(filename, mod)
47
35
os.chmod(filename, mod)
38
_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):
40
"""Return shell-quoted filename"""
41
## We could be a bit more terse by using double-quotes etc
42
f = _QUOTE_RE.sub(r'\\\1', f)
75
54
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')
57
bailout("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
78
def pumpfile(fromfile, tofile):
242
79
"""Copy contents of one file to another."""
245
b = fromfile.read(BUFSIZE)
80
tofile.write(fromfile.read())
84
"""Return a new UUID"""
86
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
87
## Linux, but we need something portable for other systems;
88
## preferably an implementation in Python.
90
return chomp(file('/proc/sys/kernel/random/uuid').readline())
92
return chomp(os.popen('uuidgen').readline())
96
if s and (s[-1] == '\n'):
104
## TODO: Maybe read in chunks to handle big files
252
105
if hasattr(f, 'tell'):
253
106
assert f.tell() == 0
265
def sha_strings(strings):
266
"""Return the sha-1 of concatenation of strings"""
268
map(s.update, strings)
269
109
return s.hexdigest()
272
112
def sha_string(f):
275
116
return s.hexdigest()
278
def fingerprint_file(f):
283
return {'size': size,
284
'sha1': s.hexdigest()}
121
"""Return email-style username.
123
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
125
:todo: Check it's reasonably well-formed.
127
:todo: Allow taking it from a dotfile to help people on windows
128
who can't easily set variables.
130
:todo: Cope without pwd module, which is only on unix.
132
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
140
w = pwd.getpwuid(uid)
142
comma = gecos.find(',')
146
realname = gecos[:comma]
147
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
151
import getpass, socket
152
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
156
"""Return just the email component of a username."""
157
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
160
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
162
bailout('%r is not a reasonable email address' % e)
166
import getpass, socket
167
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
287
172
def compare_files(a, b):
288
173
"""Returns true if equal in contents"""
174
# TODO: don't read the whole thing in one go.
291
177
ai = a.read(BUFSIZE)
325
213
tt = time.localtime(t)
326
214
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)
216
bailout("unsupported timezone format %r",
217
['options are "utc", "original", "local"'])
219
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
220
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
339
223
def compact_date(when):
345
229
"""Return size of given open file."""
346
230
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
233
if hasattr(os, 'urandom'): # python 2.4 and later
353
234
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))
236
# FIXME: No good on non-Linux
237
_rand_file = file('/dev/urandom', 'rb')
238
rand_bytes = _rand_file.read
370
241
## TODO: We could later have path objects that remember their list
371
242
## decomposition (might be too tricksy though.)
384
255
>>> splitpath('a/../b')
385
256
Traceback (most recent call last):
387
BzrError: sorry, '..' not allowed in path
258
BzrError: ("sorry, '..' not allowed in path", [])
389
260
assert isinstance(p, types.StringTypes)
391
# split on either delimiter because people might use either on
393
ps = re.split(r'[\\/]', p)
261
ps = [f for f in p.split('/') if f != '.']
398
raise BzrError("sorry, %r not allowed in path" % f)
399
elif (f == '.') or (f == ''):
264
bailout("sorry, %r not allowed in path" % f)
406
268
assert isinstance(p, list)
408
if (f == '..') or (f == None) or (f == ''):
409
raise BzrError("sorry, %r not allowed in path" % f)
410
return os.path.join(*p)
270
if (f == '..') or (f is None) or (f == ''):
271
bailout("sorry, %r not allowed in path" % f)
413
275
def appendpath(p1, p2):
417
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):
282
def extern_command(cmd, ignore_errors = False):
283
mutter('external command: %s' % `cmd`)
285
if not ignore_errors:
286
bailout('command failed')
added
removed
bzrlib/osutils.py
