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
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)
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.
135
if has_symlinks() and os.path.islink(fn):
136
target = os.readlink(fn)
137
os.symlink(target, bfn)
145
outf = file(bfn, 'wb')
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
174
"""True if f is a symlink."""
176
return S_ISLNK(os.lstat(f)[ST_MODE])
180
def is_inside(dir, fname):
181
"""True if fname is inside dir.
183
The parameters should typically be passed to os.path.normpath first, so
184
that . and .. and repeated slashes are eliminated, and the separators
185
are canonical for the platform.
187
The empty string as a dir name is taken as top-of-tree and matches
190
>>> is_inside('src', os.path.join('src', 'foo.c'))
192
>>> is_inside('src', 'srccontrol')
194
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
196
>>> is_inside('foo.c', 'foo.c')
198
>>> is_inside('foo.c', '')
200
>>> is_inside('', 'foo.c')
203
# XXX: Most callers of this can actually do something smarter by
204
# looking at the inventory
211
if dir[-1] != os.sep:
214
return fname.startswith(dir)
217
def is_inside_any(dir_list, fname):
218
"""True if fname is inside any of given dirs."""
219
for dirname in dir_list:
220
if is_inside(dirname, fname):
226
78
def pumpfile(fromfile, tofile):
227
79
"""Copy contents of one file to another."""
228
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
232
105
if hasattr(f, 'tell'):
233
106
assert f.tell() == 0
245
def sha_strings(strings):
246
"""Return the sha-1 of concatenation of strings"""
248
map(s.update, strings)
249
109
return s.hexdigest()
252
112
def sha_string(f):
255
116
return s.hexdigest()
258
120
def fingerprint_file(f):
264
127
'sha1': s.hexdigest()}
132
"""Return email-style username.
134
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
136
:todo: Check it's reasonably well-formed.
138
:todo: Allow taking it from a dotfile to help people on windows
139
who can't easily set variables.
141
:todo: Cope without pwd module, which is only on unix.
143
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
151
w = pwd.getpwuid(uid)
153
comma = gecos.find(',')
157
realname = gecos[:comma]
158
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
162
import getpass, socket
163
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
167
"""Return just the email component of a username."""
168
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
171
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
173
bailout('%r is not a reasonable email address' % e)
177
import getpass, socket
178
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
267
183
def compare_files(a, b):
268
184
"""Returns true if equal in contents"""
185
# TODO: don't read the whole thing in one go.
271
188
ai = a.read(BUFSIZE)
291
209
def format_date(t, offset=0, timezone='original'):
292
210
## TODO: Perhaps a global option to use either universal or local time?
293
211
## Or perhaps just let people set $TZ?
294
214
assert isinstance(t, float)
296
216
if timezone == 'utc':
304
224
tt = time.localtime(t)
305
225
offset = local_time_offset(t)
307
raise BzrError("unsupported timezone format %r" % timezone,
308
['options are "utc", "original", "local"'])
227
bailout("unsupported timezone format %r",
228
['options are "utc", "original", "local"'])
310
230
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
311
231
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
320
240
"""Return size of given open file."""
321
241
return os.fstat(f.fileno())[ST_SIZE]
323
# Define rand_bytes based on platform.
325
# Python 2.4 and later have os.urandom,
326
# but it doesn't work on some arches
244
if hasattr(os, 'urandom'): # python 2.4 and later
328
245
rand_bytes = os.urandom
329
except (NotImplementedError, AttributeError):
330
# If python doesn't have os.urandom, or it doesn't work,
331
# then try to first pull random data from /dev/urandom
332
if os.path.exists("/dev/urandom"):
333
rand_bytes = file('/dev/urandom', 'rb').read
334
# Otherwise, use this hack as a last resort
336
# not well seeded, but better than nothing
341
s += chr(random.randint(0, 255))
247
# FIXME: No good on non-Linux
248
_rand_file = file('/dev/urandom', 'rb')
249
rand_bytes = _rand_file.read
345
252
## TODO: We could later have path objects that remember their list
346
253
## decomposition (might be too tricksy though.)
359
266
>>> splitpath('a/../b')
360
267
Traceback (most recent call last):
362
BzrError: sorry, '..' not allowed in path
269
BzrError: ("sorry, '..' not allowed in path", [])
364
271
assert isinstance(p, types.StringTypes)
366
# split on either delimiter because people might use either on
368
ps = re.split(r'[\\/]', p)
272
ps = [f for f in p.split('/') if f != '.']
373
raise BzrError("sorry, %r not allowed in path" % f)
374
elif (f == '.') or (f == ''):
275
bailout("sorry, %r not allowed in path" % f)
381
279
assert isinstance(p, list)
383
if (f == '..') or (f == None) or (f == ''):
384
raise BzrError("sorry, %r not allowed in path" % f)
385
return os.path.join(*p)
281
if (f == '..') or (f is None) or (f == ''):
282
bailout("sorry, %r not allowed in path" % f)
388
286
def appendpath(p1, p2):
392
return os.path.join(p1, p2)
396
"""Split s into lines, but without removing the newline characters."""
397
return StringIO(s).readlines()
400
def hardlinks_good():
401
return sys.platform not in ('win32', 'cygwin', 'darwin')
404
def link_or_copy(src, dest):
405
"""Hardlink a file, or copy it if it can't be hardlinked."""
406
if not hardlinks_good():
411
except (OSError, IOError), e:
412
if e.errno != errno.EXDEV:
418
if hasattr(os, 'symlink'):
424
def contains_whitespace(s):
425
"""True if there are any whitespace characters in s."""
426
for ch in string.whitespace:
433
def contains_linebreaks(s):
434
"""True if there is any vertical whitespace in s."""
293
def extern_command(cmd, ignore_errors = False):
294
mutter('external command: %s' % `cmd`)
296
if not ignore_errors:
297
bailout('command failed')
added
removed
bzrlib/osutils.py
